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(context.Context, qfs.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(ctx context.Context, source Source, key string) (qfs.File, error)
}

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 path. paths returned by put must be prefixed with
	// the type:
	// eg. /ipfs/QmZ3KfGaSrb3cnTriJbddCzG7hwQi2j6km7Xe7hVpnsW5S
	Put(ctx context.Context, file qfs.File) (path 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(ctx context.Context, path string) (file qfs.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(ctx context.Context, path string) (exists bool, err error)

	// Delete removes the value for given `key`.
	Delete(ctx context.Context, path 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
	NewAdder(pin, wrap bool) (Adder, error)

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

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

type Pinner interface {
	Pin(ctx context.Context, key string, recursive bool) error
	Unpin(ctx context.Context, key string, recursive bool) error
}

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