# README
go-filestore
a by-reference file-backed blockstore
ā This repo is no longer maintained.
š We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/filestore. šļø Good news! There is tooling and documentation to expedite a switch in your repo.
ā ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
š Learn more, including how to take the maintainership mantle or ask questions, here.
Table of Contents
Documentation
https://godoc.org/github.com/ipfs/go-filestore
Want to hack on IPFS?
License
MIT
# Packages
No description provided by the author
# Functions
IsURL returns true if the string represents a valid URL that the urlstore can handle.
List fetches the block with the given key from the Filemanager of the given Filestore and returns a ListRes object with the information.
ListAll returns a function as an iterator which, once invoked, returns one by one each block in the Filestore's FileManager.
NewFileManager initializes a new file manager with the given datastore and root.
NewFilestore creates one using the given Blockstore and FileManager.
Verify fetches the block with the given key from the Filemanager of the given Filestore and returns a ListRes object with the information.
VerifyAll returns a function as an iterator which, once invoked, returns one by one each block in the Filestore's FileManager.
# Constants
Contents of the file changed.
Backing File Error.
Backing File Not Found.
Deprecated: use github.com/ipfs/boxo/filestore.StatusKeyNotFound.
Deprecated: use github.com/ipfs/boxo/filestore.StatusOk.
Internal Error, likely corrupt entry.
# Variables
Deprecated: use github.com/ipfs/boxo/filestore.ErrFilestoreNotEnabled.
Deprecated: use github.com/ipfs/boxo/filestore.ErrUrlstoreNotEnabled.
FilestorePrefix identifies the key prefix for FileManager blocks.
# Structs
CorruptReferenceError implements the error interface.
FileManager is a blockstore implementation which stores special blocks FilestoreNode type.
Filestore implements a Blockstore by combining a standard Blockstore to store regular blocks and a special Blockstore called FileManager to store blocks which data exists in an external file.
ListRes wraps the response of the List*() functions, which allows to obtain and verify blocks stored by the FileManager of a Filestore.
# Type aliases
Status is used to identify the state of the block data referenced by a FilestoreNode.