file

package
v0.9.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 22, 2022 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrFileNotPresent denotes file is not present
	ErrFileNotPresent = errors.New("file not present")

	// ErrFileAlreadyPresent denotes file is present
	ErrFileAlreadyPresent = errors.New("file already present in the destination dir")

	// ErrFileNotFound denotes file is not found in dfs
	ErrFileNotFound = errors.New("file not found in dfs")
)
View Source 
var (
	MetaVersion uint8 = 2

	ErrDeletedFeed = errors.New("deleted feed")
)
View Source 
var (
	ErrGzipBlSize = fmt.Errorf("gzip: block size cannot be less than %d", minBlockSizeForGzip)
)
View Source 
var (
	ErrInvalidOffset = errors.New("invalid offset")
)

Functions

func Decompress 

func Decompress(dataToDecompress []byte, compression string, blockSize uint32) ([]byte, error)

Types

type BlockInfo added in v0.5.3 

type BlockInfo struct {
	Size           uint32          `json:"size"`
	CompressedSize uint32          `json:"compressedSize"`
	Reference      utils.Reference `json:"reference"`
}

type Blocks 

type Blocks struct {
	Reference      string `json:"reference"`
	Size           string `json:"size"`
	CompressedSize string `json:"compressedSize"`
}

type Entry added in v0.5.3 

type Entry struct {
	Name             string `json:"name"`
	ContentType      string `json:"contentType"`
	Size             string `json:"size,omitempty"`
	BlockSize        string `json:"blockSize,omitempty"`
	CreationTime     string `json:"creationTime"`
	ModificationTime string `json:"modificationTime"`
	AccessTime       string `json:"accessTime"`
}

type File 

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

File represents a file in a pod

func NewFile 

func NewFile(podName string, client blockstore.Client, fd *feed.API, user utils.Address,
	m taskmanager.TaskManagerGO, logger logging.Logger) *File

NewFile creates the base file object which has all the methods related to file manipulation.

func (*File) AddToFileMap 

func (f *File) AddToFileMap(filePath string, meta *MetaData)

AddToFileMap adds a file metadata into fileMap

func (*File) BackupFromFileName added in v0.7.0 

func (f *File) BackupFromFileName(fileNameWithPath, podPassword string) (*MetaData, error)

func (*File) Download 

func (f *File) Download(podFileWithPath, podPassword string) (io.ReadCloser, uint64, error)

Download does all the validation for the existence of the file and creates a Reader to read the contents of the file from the pod.

func (*File) GetFromFileMap 

func (f *File) GetFromFileMap(filePath string) *MetaData

GetFromFileMap gets file metadata from the fileMap

func (*File) GetMetaFromFileName added in v0.5.3 

func (f *File) GetMetaFromFileName(fileNameWithPath, podPassword string, userAddress utils.Address) (*MetaData, error)

func (*File) GetStats added in v0.5.3 

func (f *File) GetStats(podName, podFileWithPath, podPassword string) (*Stats, error)

GetStats given a filename this function returns all the information about the file including the block information.

func (*File) IsFileAlreadyPresent added in v0.5.3 

func (f *File) IsFileAlreadyPresent(fileWithPath string) bool

IsFileAlreadyPresent checks if a file is present in the fileMap

func (*File) ListFiles 

func (f *File) ListFiles(files []string, podPassword string) ([]Entry, error)

ListFiles given a list of files, list files gives back the information related to each file.

func (*File) LoadFileMeta 

func (f *File) LoadFileMeta(fileNameWithPath, podPassword string) error

LoadFileMeta is used in syncing

func (*File) OpenFileForIndex 

func (f *File) OpenFileForIndex(podFile, podPassword string) (*Reader, error)

OpenFileForIndex opens file for indexing for document db from pod filepath TODO test skipcq: TCV-001

func (*File) PutMetaForFile added in v0.6.2 

func (f *File) PutMetaForFile(meta *MetaData, podPassword string) error

func (*File) ReadSeeker added in v0.9.1 

func (f *File) ReadSeeker(podFileWithPath, podPassword string) (io.ReadSeekCloser, uint64, error)

ReadSeeker does all the validation for the existence of the file and creates a ReadSeekCloser to read the contents of the file from the pod.

func (*File) RemoveAllFromFileMap added in v0.5.3 

func (f *File) RemoveAllFromFileMap()

RemoveAllFromFileMap resets the fileMap

func (*File) RemoveFromFileMap 

func (f *File) RemoveFromFileMap(filePath string)

RemoveFromFileMap removes a file metadata from fileMap

func (*File) RenameFromFileName added in v0.9.1 

func (f *File) RenameFromFileName(fileNameWithPath, newFileNameWithPath, podPassword string) (*MetaData, error)

func (*File) RmFile added in v0.5.3 

func (f *File) RmFile(podFileWithPath, podPassword string) error

RmFile deletes all the blocks of a file, and it related metadata from the Swarm network.

func (*File) Upload 

func (f *File) Upload(fd io.Reader, podFileName string, fileSize int64, blockSize uint32, podPath, compression, podPassword string) error

Upload uploads a given blob of bytes as a file in the pod. It also splits the file into number of blocks. the size of the block is provided during upload. This function also does compression of the blocks gzip/snappy if it is requested during the upload.

func (*File) WriteAt added in v0.9.1 

func (f *File) WriteAt(podFileWithPath, podPassword string, update io.Reader, offset uint64, truncate bool) (int, error)

WriteAt writes a file from a given offset

type IFile added in v0.5.3 

type IFile interface {
	Upload(fd io.Reader, podFileName string, fileSize int64, blockSize uint32, podPath, compression, podPassword string) error
	Download(podFileWithPath, podPassword string) (io.ReadCloser, uint64, error)
	ListFiles(files []string, podPassword string) ([]Entry, error)
	GetStats(podName, podFileWithPath, podPassword string) (*Stats, error)
	RmFile(podFileWithPath, podPassword string) error
	LoadFileMeta(fileNameWithPath, podPassword string) error
}

type INode added in v0.5.3 

type INode struct {
	Blocks []*BlockInfo `json:"blocks"`
}

type MetaData added in v0.5.3 

type MetaData struct {
	Version          uint8  `json:"version"`
	Path             string `json:"filePath"`
	Name             string `json:"fileName"`
	Size             uint64 `json:"fileSize"`
	BlockSize        uint32 `json:"blockSize"`
	ContentType      string `json:"contentType"`
	Compression      string `json:"compression"`
	CreationTime     int64  `json:"creationTime"`
	AccessTime       int64  `json:"accessTime"`
	ModificationTime int64  `json:"modificationTime"`
	InodeAddress     []byte `json:"fileInodeReference"`
}

type Reader 

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

func NewReader 

func NewReader(fileInode INode, client blockstore.Client, fileSize uint64, blockSize uint32, compression, encryptionPassword string, cache bool) *Reader

NewReader create a new reader object to read a file from the pod based on its configuration.

func (*Reader) Close 

func (r *Reader) Close() error

func (*Reader) Read 

func (r *Reader) Read(b []byte) (n int, err error)

Read reads a given segment of the file from the pod and returns it. it does all the related function like block extraction, block un-compression etc.

func (*Reader) ReadLine 

func (r *Reader) ReadLine() ([]byte, error)

func (*Reader) Seek 

func (r *Reader) Seek(seekOffset int64, whence int) (int64, error)

type Stats added in v0.5.3 

type Stats struct {
	PodName          string   `json:"podName"`
	FilePath         string   `json:"filePath"`
	FileName         string   `json:"fileName"`
	FileSize         string   `json:"fileSize"`
	BlockSize        string   `json:"blockSize"`
	Compression      string   `json:"compression"`
	ContentType      string   `json:"contentType"`
	CreationTime     string   `json:"creationTime"`
	ModificationTime string   `json:"modificationTime"`
	AccessTime       string   `json:"accessTime"`
	Blocks           []Blocks `json:"blocks"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.