io

package
v1.40.2 Latest Latest
Warning

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

Go to latest
Published: May 9, 2024 License: Apache-2.0 Imports: 2 Imported by: 21

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsMacOS added in v1.9.0

func IsMacOS() bool

func IsWindows added in v1.9.0

func IsWindows() bool

Types

type Progress added in v0.4.0

type Progress interface {
	// Used for updating the progress indicator progress.
	ActionWithProgress(reader io.Reader) (results io.Reader)
	// Used for setting the progress indicator progress.
	SetProgress(progress int64)
	// Aborts a progress indicator. Called on both successful and unsuccessful operations
	Abort()
	// Returns the Progress ID
	GetId() (Id int)
}

type ProgressMgr added in v0.17.0

type ProgressMgr interface {
	// Initializes a new reader progress indicator for a new file transfer.
	// Input: 'total' - file size, 'label' - the title of the operation, 'path' - the path of the file being processed.
	// Output: progress indicator id
	NewProgressReader(total int64, label, path string) (progress Progress)
	// Changes progress indicator state to merging.
	SetMergingState(id int, useSpinner bool) (bar Progress)
	// Returns the requested progress indicator.
	GetProgress(id int) (progress Progress)
	// Aborts a progress indicator. Called on both successful and unsuccessful operations.
	RemoveProgress(id int)
	// Increments the general progress by 1
	IncrementGeneralProgress()
	// Quits the whole progress mechanism.
	Quit() (err error)
	// Increments the general progress total count by given n.
	IncGeneralProgressTotalBy(n int64)
	// Replace the headline progress indicator message with new one.
	SetHeadlineMsg(msg string)
	// Terminate the headline progress indicator.
	ClearHeadlineMsg()
	// Specific initialization of reader progress indicators.
	// Should be called before the first call to NewProgressReader.
	InitProgressReaders()
}

You may implement this interface to display progress indication of files transfer (upload / download)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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