storage

Documentation

Index

• Constants
• type Content
  • func Create() (*Content, error)
  • func Open(_cid cid.Cid) (*Content, error)
  • func (c *Content) Cid() (cid.Cid, error)
  • func (c *Content) Close() error
  • func (c *Content) Push() (cid.Cid, error)
  • func (c *Content) Read(p []byte) (int, []byte, error)
  • func (c *Content) Seek(offset int64, whence int) (int64, error)
  • func (c *Content) Write(p []byte) (int, error)
• type DefaultFile
• type File
  • func (f *File) Add(data []byte, overWrite bool) (int, error)
  • func (f *File) CurrentVersion() (int, error)
  • func (f *File) Delete() error
  • func (f *File) DeleteAllVersions() error
  • func (f *File) GetFile() (file *StorageFile, err error)
  • func (f *File) Version(version uint32) *VersionedFile
  • func (f *File) Versions() ([]string, error)
• type Storage
  • func Get(storageName string) (Storage, error)
  • func New(storageName string) (Storage, error)
  • func (s Storage) Cid(fileName string) (string, error)
  • func (s Storage) File(fileName string) *File
  • func (s Storage) ListFiles() ([]File, error)
  • func (s Storage) RemainingCapacity() (int, error)
• type StorageFile
  • func (file *StorageFile) Close() error
  • func (file *StorageFile) Read(p []byte) (int, error)
• type VersionedFile

Constants

const CidBufferSize = 64

Types

type Content

type Content struct {
	Id uint32
}

func Create

func Create() (*Content, error)

Create creates and returns the new content.

func Open

func Open(_cid cid.Cid) (*Content, error)

Open creates a new content using the cid given as the file. Returns a new content.

func (*Content) Cid

func (c *Content) Cid() (cid.Cid, error)

Cid returns the cid of the file and an error.

func (*Content) Close

func (c *Content) Close() error

Close closes the file associated with the content. Returns an error.

func (*Content) Push

func (c *Content) Push() (cid.Cid, error)

Push adds the file into the network. Updates the cid of the file. Returns cid and an error

func (*Content) Read

func (c *Content) Read(p []byte) (int, []byte, error)

Read reads up to len p in the file. Returns how much was read and an error.

func (*Content) Seek

func (c *Content) Seek(offset int64, whence int) (int64, error)

Seek moves to a position inside the file. Offset is how much to move the current position Whence has three options: 0 = SeekStart, 1 = SeekCurrent, or 2 = SeekEnd Combines both offset and whence to find a new offset inside the file Returns the new offset and an error

func (*Content) Write

func (c *Content) Write(p []byte) (int, error)

Write writes the passed in data into the file. Returns how much was written and an error.

type DefaultFile

type DefaultFile interface {
	Add(data []byte, overWrite bool) (int, error)
	GetFile() (file *StorageFile, err error)
	Delete() error
	DeleteAllVersions() error
	CurrentVersion() (int, error)
	Versions() ([]string, error)
}

type File

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

func (*File) Add

func (f *File) Add(data []byte, overWrite bool) (int, error)

Add uses the data and overwrite given and adds the file to the storage. If overwrite is set to true then the current version number is not updated, and the data for the current version is updated. If overwrite is set to false, then for versioning enabled storages a new version is created For versioning disabled storages, file is only added if there is no file with the same name in the current storage. Returns the current version of the file.

func (*File) CurrentVersion

func (f *File) CurrentVersion() (int, error)

Current version looks up in the storage the latest version that is stored for that specific file. Returns the latest version for the file, if found, and an error.

func (*File) Delete

func (f *File) Delete() error

Delete uses the current file structure and the given version to delete the specific version of a file from the storage. Returns an error

func (*File) DeleteAllVersions

func (f *File) DeleteAllVersions() error

DeleteAllVersions uses the current file and deletes all version of it in the storage. Returns an error

func (*File) GetFile

func (f *File) GetFile() (file *StorageFile, err error)

GetFile grabs the the file from the storage Returns the file and an error

func (*File) Version

func (f *File) Version(version uint32) *VersionedFile

Version uses current file and given versions to create a new instance of VersionedFile Returns the created VersionedFile structure.

func (*File) Versions

func (f *File) Versions() ([]string, error)

ListVersions uses the current file and looks up all version of the file. Returns []string of all the versions and an error

type Storage

type Storage uint32

func Get

func Get(storageName string) (Storage, error)

Get returns the storage with given name. Returns the storage if it exists and an error.

func New

func New(storageName string) (Storage, error)

New creates a new storage Returns a storage and an error

func (Storage) Cid

func (s Storage) Cid(fileName string) (string, error)

Cid looks up the given filename in the given storage. Returns the cid corresponding to the file if found and an error.

func (Storage) File

func (s Storage) File(fileName string) *File

File uses the name passed in and creates a new instance of File that holds the storage and filename. Returns the File structure.

func (Storage) ListFiles

func (s Storage) ListFiles() ([]File, error)

ListFiles looks up all saved files in the given storage. Returns an array of all Files found in the storage and an error.

func (Storage) RemainingCapacity

func (s Storage) RemainingCapacity() (int, error)

Remaining capacity loops through to given storage and calculates how much space left is available. Returns the remaining space available and an error.

type StorageFile

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

func (*StorageFile) Close

func (file *StorageFile) Close() error

Close closes the current file Returns an error

func (*StorageFile) Read

func (file *StorageFile) Read(p []byte) (int, error)

Read reads the given bytes Returns an int of how much was read and an error

type VersionedFile

type VersionedFile struct {
	DefaultFile
}