cafs

type AddedFile struct {
	Path  string
	Name  string
	Bytes int64
	Hash  string
	Size  string
}

type Adder interface {
	// AddFile adds a file or directory of files to the store
	// this function will return immideately, consumers should read
	// from the Added() channel to see the results of file addition.
	AddFile(File) error
	// Added gives a channel to read added files from.
	Added() chan AddedFile
	// In IPFS land close calls adder.Finalize() and adder.PinRoot()
	// (files will only be pinned if the pin flag was set on NewAdder)
	// Close will close the underlying
	Close() error
}

type Fetcher interface {
	// Fetch gets a file from a source
	Fetch(source Source, key string) (File, error)
}

type File interface {
	// Files implement ReadCloser, but can only be read from or closed if
	// they are not directories
	io.ReadCloser

	// FileName returns a filename associated with this file
	FileName() string

	// FullPath returns the full path used when adding this file
	FullPath() string

	// IsDirectory returns true if the File is a directory (and therefore
	// supports calling `NextFile`) and false if the File is a normal file
	// (and therefor supports calling `Read` and `Close`)
	IsDirectory() bool

	// NextFile returns the next child file available (if the File is a
	// directory). It will return (nil, io.EOF) if no more files are
	// available. If the file is a regular file (not a directory), NextFile
	// will return a non-nil error.
	NextFile() (File, error)
}

type FileInfo interface {
	AbsPath() string
	Stat() os.FileInfo
}

type Filestore interface {
	// Put places a file or a directory in the store.
	// The most notable difference from a standard file store is the store itself determines
	// the resulting key (google "content addressing" for more info ;)
	// keys returned by put must be prefixed with the PathPrefix,
	// eg. /ipfs/QmZ3KfGaSrb3cnTriJbddCzG7hwQi2j6km7Xe7hVpnsW5S
	Put(file File, pin bool) (key string, err error)

	// Get retrieves the object `value` named by `key`.
	// Get will return ErrNotFound if the key is not mapped to a value.
	Get(key string) (file File, err error)

	// Has returns whether the `key` is mapped to a `value`.
	// In some contexts, it may be much cheaper only to check for existence of
	// a value, rather than retrieving the value itself. (e.g. HTTP HEAD).
	// The default implementation is found in `GetBackedHas`.
	Has(key string) (exists bool, err error)

	// Delete removes the value for given `key`.
	Delete(key string) error

	// NewAdder allocates an Adder instance for adding files to the filestore
	// Adder gives a higher degree of control over the file adding process at the
	// cost of being harder to work with.
	// "pin" is a flag for recursively pinning this object
	// "wrap" sets weather the top level should be wrapped in a directory
	// expect this to change to something like:
	// NewAdder(opt map[string]interface{}) (Adder, error)
	NewAdder(pin, wrap bool) (Adder, error)

	// PathPrefix is a top-level identifier to distinguish between filestores,
	// for exmple: the "ipfs" in /ipfs/QmZ3KfGaSrb3cnTriJbddCzG7hwQi2j6km7Xe7hVpnsW5S
	// a Filestore implementation should always return the same
	PathPrefix() string
}

type MapStore struct {
	Pinned  bool
	Network []*MapStore
	Files   map[string]filer
}

type Memdir struct {
	// contains filtered or unexported fields
}

type Memfile struct {
	// contains filtered or unexported fields
}

type PathSetter interface {
	SetPath(path string)
}

type PeekFile interface {
	SizeFile

	Peek(n int) File
	Length() int
}

type Pinner interface {
	Pin(key string, recursive bool) error
	Unpin(key string, recursive bool) error
}

type SizeFile interface {
	File

	Size() (int64, error)
}

type Source interface {
	// address should return the base resource identifier in either content
	// or location based addressing schemes
	Address() string
}

type StatFile interface {
	File

	Stat() os.FileInfo
}