package
1.3.4
Repository: https://github.com/getdatcrypto/nimbus.git
Documentation: pkg.go.dev

# Packages

Package contractor is responsible for forming and renewing file contracts with hosts.
Package hostdb provides a HostDB object that implements the renter.hostDB interface.
No description provided by the author

# Functions

New returns an initialized renter.
NewCustomRenter initializes a renter and returns it.
NewDownloadDestinationBuffer allocates the necessary number of shards for the downloadDestinationBuffer and returns the new buffer.
NewRSCode creates a new Reed-Solomon encoder/decoder using the supplied parameters.

# Constants

DefaultMaxDownloadSpeed is set to zero to indicate no limit, the user can set a custom MaxDownloadSpeed through the API.
DefaultMaxUploadSpeed is set to zero to indicate no limit, the user can set a custom MaxUploadSpeed through the API.
DefaultStreamCacheSize is the default cache size of the /renter/stream cache in chunks, the user can set a custom cache size through the API.
PersistFilename is the filename to be used when persisting renter information to a JSON file.
ShareExtension is the extension to be used.

# Variables

ErrBadFile is an error when a file does not qualify as .sia file.
ErrEmptyFilename is an error when filename is empty.
ErrIncompatible is an error when file is not compatible with current version.
ErrNoNicknames is an error when no nickname is given.
ErrNonShareSuffix is an error when the suffix of a file does not match the defined share extension.
ErrPathOverload is an error when a file already exists at that location.
ErrUnknownPath is an error when a file cannot be found with the given path.
RemoteRepairDownloadThreshold defines the threshold in percent under which the renter starts repairing a file that is not available on disk.

# Structs

A Renter is responsible for tracking all of the files that a user has uploaded to Sia, as well as the locations and health of these files.