file

Documentation

Index

• type File
• type FileDict
• type FileStore
  • func NewFileStore(info *InfoDict, fileSystem FileSystem) (FileStore, int64, error)
• type FileSystem
• type FsProvider
• type InfoDict
  • func (i *InfoDict) ToMap() (m map[string]interface{})
• type OsFsProvider
  • func (o OsFsProvider) NewFS(directory string) (fs FileSystem, err error)

Types

type File

type File interface {
	io.ReaderAt
	io.WriterAt
	io.Closer
}

Interface for a file. Multiple goroutines may access a File at the same time.

type FileDict

type FileDict struct {
	Length int64
	Path   []string
	Md5sum string
}

type FileStore

type FileStore interface {
	io.ReaderAt
	io.Closer
	WritePiece(buffer []byte, piece int) (written int, err error)
}

A torrent file store. WritePiece should be called for full, verified pieces only;

func NewFileStore

func NewFileStore(info *InfoDict, fileSystem FileSystem) (FileStore, int64, error)

type FileSystem

type FileSystem interface {
	Open(name []string, length int64) (file File, err error)
	io.Closer
}

Interface for a file system. A file system contains files.

type FsProvider

type FsProvider interface {
	NewFS(directory string) (FileSystem, error)
}

Interface for a provider of filesystems.

type InfoDict

type InfoDict struct {
	PieceLength int64 `bencode:"piece length"`
	Pieces      string
	Private     int64
	Name        string
	// Single File Mode
	Length int64
	Md5sum string
	// Multiple File mode
	Files []FileDict
}

func (*InfoDict) ToMap

func (i *InfoDict) ToMap() (m map[string]interface{})

Copy the non-default values from an InfoDict to a map.

type OsFsProvider

type OsFsProvider struct{}

func (OsFsProvider) NewFS

func (o OsFsProvider) NewFS(directory string) (fs FileSystem, err error)