manifest

Documentation

Overview

Package manifest contains the abstractions needed for collection representation in Aurora. It uses implementations in ethersphere/manifest repo under the hood.

Index

• Constants
• Variables
• type Entry
  • func NewEntry(reference boson.Address, metadata map[string]string) Entry
• type Interface
  • func NewDefaultManifest(ls file.LoadSaver, encrypted bool) (Interface, error)
  • func NewDefaultManifestReference(reference boson.Address, ls file.LoadSaver) (Interface, error)
  • func NewManifest(manifestType string, ls file.LoadSaver, encrypted bool) (Interface, error)
  • func NewManifestReference(manifestType string, reference boson.Address, ls file.LoadSaver) (Interface, error)
  • func NewMantarayManifest(ls file.LoadSaver, encrypted bool) (Interface, error)
  • func NewMantarayManifestReference(reference boson.Address, ls file.LoadSaver) (Interface, error)
  • func NewSimpleManifest(ls file.LoadSaver) (Interface, error)
  • func NewSimpleManifestReference(ref boson.Address, l file.LoadSaver) (Interface, error)
• type NodeIterFunc
• type NodeType
  • func (t NodeType) String() string
• type StoreSizeFunc

Constants

const (
	RootPath                      = "/"
	WebsiteIndexDocumentSuffixKey = "website-index-document"
	WebsiteErrorDocumentPathKey   = "website-error-document"
	EntryMetadataContentTypeKey   = "Content-Type"
	EntryMetadataDirnameKey       = "Dirname"
	EntryMetadataFilenameKey      = "Filename"
)

const DefaultManifestType = ManifestMantarayContentType

const (
	// ManifestMantarayContentType represents content type used for noting that
	// specific file should be processed as mantaray manifest.
	ManifestMantarayContentType = "application/aurora-manifest-mantaray+octet-stream"
)

const (
	// ManifestSimpleContentType represents content type used for noting that
	// specific file should be processed as 'simple' manifest
	ManifestSimpleContentType = "application/aurora-manifest-simple+json"
)

Variables

var (
	// ErrNotFound is returned when an Entry is not found in the manifest.
	ErrNotFound = errors.New("manifest: not found")

	// ErrInvalidManifestType is returned when an unknown manifest type
	// is provided to the function.
	ErrInvalidManifestType = errors.New("manifest: invalid type")

	// ErrMissingReference is returned when the reference for the manifest file
	// is missing.
	ErrMissingReference = errors.New("manifest: missing reference")
)

Types

type Entry

type Entry interface {
	// Reference returns the address of the file.
	Reference() boson.Address
	// Metadata returns the metadata of the file.
	Metadata() map[string]string
}

Entry represents a single manifest entry.

func NewEntry

func NewEntry(reference boson.Address, metadata map[string]string) Entry

NewEntry creates a new manifest entry.

type Interface

type Interface interface {
	// Type returns manifest implementation type information
	Type() string
	// Add a manifest entry to the specified path.
	Add(context.Context, string, Entry) error
	// Remove a manifest entry on the specified path.
	Remove(context.Context, string) error
	// Lookup returns a manifest entry if one is found in the specified path.
	Lookup(context.Context, string) (Entry, error)
	// HasPrefix tests whether the specified prefix path exists.
	HasPrefix(context.Context, string) (bool, error)
	// Store stores the manifest, returning the resulting address.
	Store(context.Context, ...StoreSizeFunc) (boson.Address, error)
	// IterateDirectories is used to iterate over directory or file for the
	// manifest.
	IterateDirectories(context.Context, []byte, int, NodeIterFunc) error
	// IterateAddresses is used to iterate over chunks addresses for
	// the manifest.
	IterateAddresses(context.Context, boson.AddressIterFunc) error
}

Interface for operations with manifest.

func NewDefaultManifest

func NewDefaultManifest(
	ls file.LoadSaver,
	encrypted bool,
) (Interface, error)

NewDefaultManifest creates a new manifest with default type.

func NewDefaultManifestReference

func NewDefaultManifestReference(
	reference boson.Address,
	ls file.LoadSaver,
) (Interface, error)

NewDefaultManifestReference creates a new manifest with default type.

func NewManifest

func NewManifest(
	manifestType string,
	ls file.LoadSaver,
	encrypted bool,
) (Interface, error)

NewManifest creates a new manifest.

func NewManifestReference

func NewManifestReference(
	manifestType string,
	reference boson.Address,
	ls file.LoadSaver,
) (Interface, error)

NewManifestReference loads existing manifest.

func NewMantarayManifest

func NewMantarayManifest(
	ls file.LoadSaver,
	encrypted bool,
) (Interface, error)

NewMantarayManifest creates a new mantaray-based manifest.

func NewMantarayManifestReference

func NewMantarayManifestReference(
	reference boson.Address,
	ls file.LoadSaver,
) (Interface, error)

NewMantarayManifestReference loads existing mantaray-based manifest.

func NewSimpleManifest

func NewSimpleManifest(ls file.LoadSaver) (Interface, error)

NewSimpleManifest creates a new simple manifest.

func NewSimpleManifestReference

func NewSimpleManifestReference(ref boson.Address, l file.LoadSaver) (Interface, error)

NewSimpleManifestReference loads existing simple manifest.

type NodeIterFunc

type NodeIterFunc func(nodeType int, path, prefix, hash []byte, metadata map[string]string) error

NodeIterFunc is a callback on each level.

type NodeType

type NodeType int

NodeType represents a Node stored file or directory

const (
	File NodeType = iota
	Directory
	IndexItem
)

func (NodeType) String

func (t NodeType) String() string

type StoreSizeFunc

type StoreSizeFunc func(int64) error

StoreSizeFunc is a callback on every content size that will be stored by the Store function.