uploader

package

v0.23.0 Latest Latest Go to latest Published: Feb 8, 2021 License: MIT Imports: 17 Imported by: 41

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gotd/td

Links

Documentation ¶

Overview ¶

Package uploader contains uploading files helpers.

Index ¶

Constants
type File
type Progress
type ProgressState
type Upload
- func FromReader(name string, from io.Reader, total int64) *Upload
- func NewUpload(name string, from io.Reader, total int64) *Upload
type Uploader
- func NewUploader(rpc *tg.Client) *Uploader

Constants ¶

View Source

const (

	// `524288 % part_size = 0` (512KB must be evenly divisible by part_size)
	MaximumPartSize = 524288
)

https://core.telegram.org/api/files#uploading-files

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type File ¶

type File interface {
	Name() string
	Stat() (os.FileInfo, error)
	io.Reader
}

File is file abstraction.

type Progress ¶

type Progress interface {
	Chunk(ctx context.Context, state ProgressState) error
}

Progress is interface of upload process tracker.

type ProgressState ¶

type ProgressState struct {
	ID       int64
	Name     string
	Part     int
	PartSize int
	Uploaded int
	Total    int
}

ProgressState represents upload state change.

type Upload ¶

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

Upload represents Telegram file upload.

func FromReader ¶

func FromReader(name string, from io.Reader, total int64) *Upload

FromReader creates new Upload struct using given io.Reader.

func NewUpload ¶

func NewUpload(name string, from io.Reader, total int64) *Upload

NewUpload creates new Upload struct using given name and reader.

type Uploader ¶

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

Uploader is Telegram file uploader.

func NewUploader ¶

func NewUploader(rpc *tg.Client) *Uploader

NewUploader creates new Uploader.

func (*Uploader) FromFile ¶ added in v0.23.0

func (u *Uploader) FromFile(ctx context.Context, f File) (tg.InputFileClass, error)

FromFile uploads given File. NB: UploadFromFile does not close given file.

func (*Uploader) FromPath ¶ added in v0.23.0

func (u *Uploader) FromPath(ctx context.Context, path string) (tg.InputFileClass, error)

FromPath uploads file from given path.

func (*Uploader) Upload ¶

func (u *Uploader) Upload(ctx context.Context, upload *Upload) (tg.InputFileClass, error)

Upload uploads data from Upload object.

func (*Uploader) WithIDGenerator ¶

func (u *Uploader) WithIDGenerator(cb func() (int64, error)) *Uploader

WithIDGenerator sets id generator.

func (*Uploader) WithPartSize ¶

func (u *Uploader) WithPartSize(partSize int) *Uploader

WithPartSize sets part size. Should be divisible by 1024. 524288 should be divisible by partSize.

See https://core.telegram.org/api/files#uploading-files.

func (*Uploader) WithProgress ¶

func (u *Uploader) WithProgress(progress Progress) *Uploader

WithProgress sets progress callback.

func (*Uploader) WithThreads ¶

func (u *Uploader) WithThreads(limit int) *Uploader

WithThreads sets uploading goroutines limit per upload.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL