Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

siafile

package

Go to main page

Versions in this module

v1

v1.5.9

Jul 21, 2022

v1.5.9-rc2

Jul 7, 2022

v1.5.9-rc1

Jul 1, 2022

v1.5.8

May 18, 2022

v1.5.8-rc1

May 18, 2022

v1.5.7

Sep 21, 2021

Changes in this version

+ const CombinedChunkStatusCompleted

+ const CombinedChunkStatusInComplete

+ const CombinedChunkStatusInvalid

+ var ErrDeleted = errors.New("files was deleted")

+ var ErrPathOverload = errors.New("a file already exists at that location")

+ var ErrUnknownPath = errors.New("no file known with that path")

+ var ErrUnknownThread = errors.New("thread should not be calling Close(), does not have control of the siafile")

+ func ApplyUpdates(updates ...writeaheadlog.Update) error

+ func CalculateHealth(goodPieces, minPieces, numPieces int) float64

+ func CombinedChunkIndex(numChunks, chunkIndex uint64, numCombinedChunks int) int

+ func IsSiaFileUpdate(update writeaheadlog.Update) bool

+ func LoadSiaFileFromReaderWithChunks(r io.ReadSeeker, path string, wal *writeaheadlog.WAL) (*SiaFile, Chunks, error)

+ type BubbledMetadata struct

+ Health float64

+ LastHealthCheckTime time.Time

+ ModTime time.Time

+ NumStuckChunks uint64

+ OnDisk bool

+ Redundancy float64

+ RepairBytes uint64

+ Size uint64

+ StuckBytes uint64

+ StuckHealth float64

+ UID SiafileUID

+ type Chunk struct

+ Pieces [][]Piece

+ type Chunks struct

+ type FileChunk struct

+ Pieces [][]Piece

+ type FileData struct

+ Chunks []FileChunk

+ Deleted bool

+ ErasureCode modules.ErasureCoder

+ FileSize uint64

+ MasterKey [crypto.EntropySize]byte

+ Mode os.FileMode

+ Name string

+ PieceSize uint64

+ RepairPath string

+ UID SiafileUID

+ type HostPublicKey struct

+ PublicKey types.SiaPublicKey

+ Used bool

+ func (hpk *HostPublicKey) UnmarshalSia(r io.Reader) error

+ func (hpk HostPublicKey) MarshalSia(w io.Writer) error

+ type Metadata struct

+ AccessTime time.Time

+ CachedExpiration types.BlockHeight

+ CachedHealth float64

+ CachedNumStuckChunks uint64

+ CachedRedundancy float64

+ CachedRepairBytes uint64

+ CachedStuckBytes uint64

+ CachedStuckHealth float64

+ CachedUploadProgress float64

+ CachedUploadedBytes uint64

+ CachedUserRedundancy float64

+ ChangeTime time.Time

+ ChunkOffset int64

+ CreateTime time.Time

+ DisablePartialChunk bool

+ FileSize int64

+ GroupID int32

+ HasPartialChunk bool

+ Health float64

+ LastHealthCheckTime time.Time

+ LocalPath string

+ ModTime time.Time

+ Mode os.FileMode

+ NumStuckChunks uint64

+ PartialChunks []PartialChunkInfo

+ PubKeyTableOffset int64

+ Redundancy float64

+ RepairBytes uint64

+ StaticErasureCodeParams [8]byte

+ StaticErasureCodeType [4]byte

+ StaticMasterKey []byte

+ StaticMasterKeyType crypto.CipherType

+ StaticPagesPerChunk uint8

+ StaticPieceSize uint64

+ StaticSharingKey []byte

+ StaticSharingKeyType crypto.CipherType

+ StaticVersion [16]byte

+ StuckBytes uint64

+ StuckHealth float64

+ UniqueID SiafileUID

+ UserID int32

+ func LoadSiaFileMetadata(path string) (Metadata, error)

+ type PartialChunkInfo struct

+ ID modules.CombinedChunkID

+ Index uint64

+ Length uint64

+ Offset uint64

+ Status uint8

+ type Piece struct

+ HostPubKey types.SiaPublicKey

+ MerkleRoot crypto.Hash

+ type SiaFile struct

+ func LoadSiaFile(path string, wal *writeaheadlog.WAL) (*SiaFile, error)

+ func LoadSiaFileFromReader(r io.ReadSeeker, path string, wal *writeaheadlog.WAL) (*SiaFile, error)

+ func New(siaFilePath, source string, wal *writeaheadlog.WAL, ...) (*SiaFile, error)

+ func NewFromLegacyData(fd FileData, siaFilePath string, wal *writeaheadlog.WAL) (*SiaFile, error)

+ func (sf *SiaFile) AccessTime() time.Time

+ func (sf *SiaFile) AddPiece(pk types.SiaPublicKey, chunkIndex, pieceIndex uint64, merkleRoot crypto.Hash) (err error)

+ func (sf *SiaFile) ChangeTime() time.Time

+ func (sf *SiaFile) Chunk(chunkIndex uint64) (chunk, error)

+ func (sf *SiaFile) ChunkHealth(index int, offlineMap map[string]bool, goodForRenewMap map[string]bool) (float64, float64, uint64, error)

+ func (sf *SiaFile) ChunkSize() uint64

+ func (sf *SiaFile) CreateTime() time.Time

+ func (sf *SiaFile) Delete() (err error)

+ func (sf *SiaFile) Deleted() bool

+ func (sf *SiaFile) ErasureCode() modules.ErasureCoder

+ func (sf *SiaFile) Expiration(contracts map[string]modules.RenterContract) types.BlockHeight

+ func (sf *SiaFile) GoodPieces(chunkIndex int, offlineMap map[string]bool, goodForRenewMap map[string]bool) (uint64, uint64)

+ func (sf *SiaFile) GrowNumChunks(numChunks uint64) (err error)

+ func (sf *SiaFile) HasPartialChunk() bool

+ func (sf *SiaFile) Health(offline map[string]bool, goodForRenew map[string]bool) (h, sh, uh, ush float64, nsc, rb, sb uint64)

+ func (sf *SiaFile) HostPublicKeys() (spks []types.SiaPublicKey)

+ func (sf *SiaFile) IsIncludedPartialChunk(chunkIndex uint64) bool

+ func (sf *SiaFile) IsIncompletePartialChunk(chunkIndex uint64) bool

+ func (sf *SiaFile) LastHealthCheckTime() time.Time

+ func (sf *SiaFile) LocalPath() string

+ func (sf *SiaFile) Lock()

+ func (sf *SiaFile) MasterKey() crypto.CipherKey

+ func (sf *SiaFile) Merge(newFile *SiaFile) (map[uint64]uint64, error)

+ func (sf *SiaFile) Metadata() Metadata

+ func (sf *SiaFile) ModTime() time.Time

+ func (sf *SiaFile) Mode() os.FileMode

+ func (sf *SiaFile) NumChunks() uint64

+ func (sf *SiaFile) NumStuckChunks() uint64

+ func (sf *SiaFile) PartialChunks() []PartialChunkInfo

+ func (sf *SiaFile) PieceSize() uint64

+ func (sf *SiaFile) Pieces(chunkIndex uint64) ([][]Piece, error)

+ func (sf *SiaFile) Redundancy(offlineMap map[string]bool, goodForRenewMap map[string]bool) (r, ur float64, err error)

+ func (sf *SiaFile) RemoveLastChunk() error

+ func (sf *SiaFile) Rename(newSiaFilePath string) error

+ func (sf *SiaFile) SaveHeader() (err error)

+ func (sf *SiaFile) SaveMetadata() (err error)

+ func (sf *SiaFile) SaveWithChunks(chunks Chunks) (err error)

+ func (sf *SiaFile) SetAllStuck(stuck bool) (err error)

+ func (sf *SiaFile) SetChunkStatusCompleted(pci uint64) (err error)

+ func (sf *SiaFile) SetFileSize(fileSize uint64) (err error)

+ func (sf *SiaFile) SetLastHealthCheckTime()

+ func (sf *SiaFile) SetLocalPath(path string) (err error)

+ func (sf *SiaFile) SetMode(mode os.FileMode) (err error)

+ func (sf *SiaFile) SetPartialChunks(combinedChunks []modules.PartialChunk, updates []writeaheadlog.Update) (err error)

+ func (sf *SiaFile) SetPartialsSiaFile(partialsSiaFile *SiaFile)

+ func (sf *SiaFile) SetSiaFilePath(path string)

+ func (sf *SiaFile) SetStuck(index uint64, stuck bool) (err error)

+ func (sf *SiaFile) SiaFilePath() string

+ func (sf *SiaFile) Size() uint64

+ func (sf *SiaFile) Snapshot(sp modules.SiaPath) (*Snapshot, error)

+ func (sf *SiaFile) SnapshotRange(sp modules.SiaPath, offset, length uint64) (*Snapshot, error)

+ func (sf *SiaFile) SnapshotReader() (*SnapshotReader, error)

+ func (sf *SiaFile) StuckChunkByIndex(index uint64) (bool, error)

+ func (sf *SiaFile) UID() SiafileUID

+ func (sf *SiaFile) Unlock()

+ func (sf *SiaFile) UnmanagedSetDeleted(deleted bool)

+ func (sf *SiaFile) UnmanagedSetSiaFilePath(newSiaFilePath string)

+ func (sf *SiaFile) UpdateAccessTime() (err error)

+ func (sf *SiaFile) UpdateUniqueID()

+ func (sf *SiaFile) UpdateUsedHosts(used []types.SiaPublicKey) (err error)

+ func (sf *SiaFile) UploadProgressAndBytes() (float64, uint64, error)

+ type SiafileUID string

+ type Snapshot struct

+ func SnapshotFromReader(sp modules.SiaPath, r io.Reader) (*Snapshot, error)

+ func (s *Snapshot) ChunkIndexByOffset(offset uint64) (chunkIndex uint64, off uint64)

+ func (s *Snapshot) ChunkSize() uint64

+ func (s *Snapshot) ErasureCode() modules.ErasureCoder

+ func (s *Snapshot) IsIncludedPartialChunk(chunkIndex uint64) (PartialChunkInfo, bool)

+ func (s *Snapshot) IsIncompletePartialChunk(chunkIndex uint64) bool

+ func (s *Snapshot) LocalPath() string

+ func (s *Snapshot) MasterKey() crypto.CipherKey

+ func (s *Snapshot) Mode() os.FileMode

+ func (s *Snapshot) NumChunks() uint64

+ func (s *Snapshot) PartialChunks() []PartialChunkInfo

+ func (s *Snapshot) PieceSize() uint64

+ func (s *Snapshot) Pieces(chunkIndex uint64) [][]Piece

+ func (s *Snapshot) SiaPath() modules.SiaPath

+ func (s *Snapshot) Size() uint64

+ func (s *Snapshot) UID() SiafileUID

+ type SnapshotReader struct

+ func (sfr *SnapshotReader) Close() error

+ func (sfr *SnapshotReader) Read(b []byte) (int, error)

+ func (sfr *SnapshotReader) Stat() (os.FileInfo, error)

v1.5.7-rc1

Aug 28, 2021

v1.5.7-rc

Aug 28, 2021