Documentation
¶
Index ¶
- Constants
- Variables
- type Content
- 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
- type StorageFile
- type VersionedFile
Constants ¶
const CidBufferSize = 64
Variables ¶
var ContentCloseFile = func(contentId *Content) (error errno.Error) { return errno.ErrorNone }
var ContentFileCid = func(contentId *Content, cidPtr *byte) (error errno.Error) { return errno.ErrorNone }
var ContentPushFile = func(contentId *Content, cidPtr *byte) (error errno.Error) { return errno.ErrorNone }
var ContentReadFile = func(contentId *Content, buf *byte, bufLen uint32, dataPtr *byte, readPtr *int32) (error errno.Error) { return errno.ErrorNone }
var ContentSeekFile = func(contentId *Content, offset int64, whence int, offsetPtr *int) (error errno.Error) { return errno.ErrorNone }
var ContentWriteFile = func(contentId *Content, buf *byte, bufLen uint32, writePtr *int32) (error errno.Error) { return errno.ErrorNone }
var StorageAddFile = func(storageId uint32, fileName string, versionPtr *uint32, bufPtr *byte, bufLen uint32, overWrite uint32) (error errno.Error) { return errno.ErrorNone }
var StorageCapacity = func(storageId uint32, capacityPtr *byte) (error errno.Error) { return errno.ErrorNone }
var StorageCapacitySize = func(storageId uint32, sizePtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageCid = func(cidPtr *byte, idPtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageCidSize = func(storageId uint32, fileName string, idPtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageCloseFile = func(storageId uint32, fd uint32) (error errno.Error) { return errno.ErrorNone }
var StorageCurrentVersion = func(filename string, versionPtr *byte) (error errno.Error) { return errno.ErrorNone }
var StorageCurrentVersionSize = func(storageId uint32, fileName string, sizePtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageDeleteFile = func(storageId uint32, fileName string, version uint32, all uint32) (error errno.Error) { return errno.ErrorNone }
var StorageGet = func(storageName string, idPtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageGetFile = func(storageId uint32, fileName string, version uint32, fdPtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageListFiles = func(storageId uint32, bufPtr *byte) (error errno.Error) { return errno.ErrorNone }
var StorageListFilesSize = func(storageId uint32, sizePtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageListVersions = func(storageId uint32, fileName string, versionPtr *byte) (error errno.Error) { return errno.ErrorNone }
var StorageListVersionsSize = func(storageId uint32, fileName string, sizePtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageNew = func(storageName string, idPtr *uint32) (error errno.Error) { return errno.ErrorNone }
var StorageNewContent = func(contentId *Content) (error errno.Error) { return errno.ErrorNone }
var StorageOpenCid = func(contentId *Content, cid *byte, cidSize uint32) (error errno.Error) { return errno.ErrorNone }
var StorageReadFile = func(storageId uint32, fd uint32, buf *byte, bufSize uint32, count *uint32) (error errno.Error) { return errno.ErrorNone }
Functions ¶
This section is empty.
Types ¶
type Content ¶ added in v0.1.24
type Content struct{}
func Open ¶ added in v0.1.24
Open creates a new content using the cid given as the file. Returns a new content.
func (*Content) Close ¶ added in v0.1.24
Close closes the file associated with the content. Returns an error.
func (*Content) Push ¶ added in v0.1.24
Push adds the file into the network. Updates the cid of the file. Returns cid and an error
func (*Content) Read ¶ added in v0.1.24
Read reads up to len p in the file. Returns how much was read and an error.
func (*Content) Seek ¶ added in v0.1.24
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
type DefaultFile ¶
type File ¶
type File struct {
// contains filtered or unexported fields
}
func (*File) Add ¶ added in v0.1.20
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 ¶ added in v0.1.20
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 ¶ added in v0.1.20
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 ¶
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.
type Storage ¶
type Storage uint32
func (Storage) Cid ¶ added in v0.1.20
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 ¶
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 ¶ added in v0.1.20
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 ¶
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
type VersionedFile ¶
type VersionedFile struct {
DefaultFile
}
Source Files