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

fs

package

Go to main page

Versions in this module

v1

v1.69.23

Mar 12, 2025

v1.69.22

Mar 12, 2025

v1.69.21

Mar 12, 2025

v1.69.2

Mar 12, 2025

retracted

Changes in this version

+ const ConfigAll

+ const ConfigKeyEphemeralPrefix

+ const ConfigToken

+ const CountSuffixBase

+ const CountSuffixMax

+ const CountSuffixMaxValue

+ const CountSuffixMinValue

+ const DaemonMarkChild — darwin/amd64, linux/amd64

+ const DaemonMarkVar — darwin/amd64, linux/amd64

+ const DurationOff

+ const Exa

+ const Giga

+ const Kilo

+ const LinkSuffix

+ const MaxLevel

+ const Mega

+ const ModTimeNotSupported

+ const Peta

+ const SizeSuffixMax

+ const SizeSuffixMaxValue

+ const SizeSuffixMinValue

+ const Tera

+ var ConfigEdit = "config_fs_edit"

+ var ConfigFileGet = func(section, key string) (string, bool)

+ var ConfigFileHasSection = func(section string) bool

+ var ConfigFileSet = func(section, key, value string) (err error)

+ var ConfigOAuth func(ctx context.Context, name string, m configmap.Mapper, ri *RegInfo, in ConfigIn) (*ConfigOut, error)

+ var ConfigOptionsInfo = Options

+ var ConfigProvider = "provider"

+ var CountError = func(ctx context.Context, err error) error

+ var DumpFlagsList = DumpHeaders.Help()

+ var ErrorCantCopy = errors.New("can't copy object - incompatible remotes")

+ var ErrorCantDirMove = errors.New("can't move directory - incompatible remotes")

+ var ErrorCantMove = errors.New("can't move object - incompatible remotes")

+ var ErrorCantPurge = errors.New("can't purge directory")

+ var ErrorCantSetModTime = errors.New("can't set modified time")

+ var ErrorCantSetModTimeWithoutDelete = errors.New("can't set modified time without deleting existing object")

+ var ErrorCantShareDirectories = errors.New("this backend can't share directories with link")

+ var ErrorCantUploadEmptyFiles = errors.New("can't upload empty files to this remote")

+ var ErrorCommandNotFound = errors.New("command not found")

+ var ErrorDirExists = errors.New("can't copy directory - destination already exists")

+ var ErrorDirNotFound = errors.New("directory not found")

+ var ErrorDirectoryNotEmpty = errors.New("directory not empty")

+ var ErrorFileNameTooLong = errors.New("file name too long")

+ var ErrorImmutableModified = errors.New("immutable file modified")

+ var ErrorIsDir = errors.New("is a directory not a file")

+ var ErrorIsFile = errors.New("is a file not a directory")

+ var ErrorLevelNotSupported = errors.New("level value not supported")

+ var ErrorListAborted = errors.New("list aborted")

+ var ErrorListBucketRequired = errors.New("bucket or container name is needed in remote")

+ var ErrorNotAFile = errors.New("is not a regular file")

+ var ErrorNotDeleting = errors.New("not deleting files as there were IO errors")

+ var ErrorNotDeletingDirs = errors.New("not deleting directories as there were IO errors")

+ var ErrorNotFoundInConfigFile = errors.New("didn't find section in config file")

+ var ErrorNotImplemented = errors.New("optional feature not implemented")

+ var ErrorObjectNotFound = errors.New("object not found")

+ var ErrorOverlapping = errors.New(...)

+ var ErrorPermissionDenied = errors.New("permission denied")

+ var InstallJSONLogger = func(logLevel LogLevel)

+ var LogOutput = func(level LogLevel, text string)

+ var LogPrintPid = false

+ var OptionsRegistry = map[string]OptionsInfo

+ var PassDaemonArgsAsEnviron bool

+ var Registry []*RegInfo

+ var Version string

+ var VersionSuffix = "DEV"

+ var VersionTag = "v1.70.0"

+ func CheckClose(c io.Closer, err *error)

+ func CompareDirEntries(a, b DirEntry) int

+ func ConfigMap(prefix string, options Options, configName string, ...) (config *configmap.Map)

+ func ConfigOAuthOnly(ctx context.Context) context.Context

+ func ConfigString(f Info) string

+ func ConfigStringFull(f Fs) string

+ func ConfigToEnv(section, name string) string

+ func CopyConfig(dstCtx, srcCtx context.Context) context.Context

+ func Debug(o any, text string)

+ func Debugf(o any, text string, args ...any)

+ func DirEntryType(d DirEntry) string

+ func DirectoryOptionalInterfaces(d Directory) (supported, unsupported []string)

+ func Error(o any, text string)

+ func Errorf(o any, text string, args ...any)

+ func Fatal(o any, text string)

+ func Fatalf(o any, text string, args ...any)

+ func FileExists(ctx context.Context, fs Fs, remote string) (bool, error)

+ func Fingerprint(ctx context.Context, o ObjectInfo, fast bool) string

+ func FixRangeOption(options []OpenOption, size int64)

+ func FullPath(o Object) string

+ func GetModifyWindow(ctx context.Context, fss ...Info) time.Duration

+ func GlobalOptionsInit() error

+ func Infoc(o any, text string)

+ func Infof(o any, text string, args ...any)

+ func IsDaemon() bool

+ func IsMountHelper() bool

+ func Log(o any, text string)

+ func LogDirName(f Fs, dir string) any

+ func LogLevelPrint(level LogLevel, o any, text string)

+ func LogLevelPrintf(level LogLevel, o any, text string, args ...any)

+ func LogPrint(level LogLevel, o any, text string)

+ func LogPrintf(level LogLevel, o any, text string, args ...any)

+ func Logf(o any, text string, args ...any)

+ func MatchProvider(providerConfig, provider string) bool

+ func MimeType(ctx context.Context, o DirEntry) (mimeType string)

+ func MimeTypeDirEntry(ctx context.Context, item DirEntry) string

+ func MimeTypeFromName(remote string) (mimeType string)

+ func NewUsageValue(value int64) *int64

+ func ObjectOptionalInterfaces(o Object) (supported, unsupported []string)

+ func OpenOptionAddHTTPHeaders(headers http.Header, options []OpenOption)

+ func OpenOptionAddHeaders(options []OpenOption, headers map[string]string)

+ func OpenOptionHeaders(options []OpenOption) (headers map[string]string)

+ func OptionToEnv(name string) string

+ func Panic(o any, text string)

+ func Panicf(o any, text string, args ...any)

+ func ParseDuration(age string) (time.Duration, error)

+ func ParseTime(date string) (t time.Time, err error)

+ func PrettyPrint(in any, label string, level LogLevel)

+ func Print(o any, text string)

+ func Printf(o any, text string, args ...any)

+ func Register(info *RegInfo)

+ func RegisterGlobalOptions(oi OptionsInfo)

+ func StatePop(state string) (newState string, value string)

+ func StatePush(state string, values ...string) string

+ func Type(f Fs) string

+ func UnmarshalJSONFlag(in []byte, x interface{ ... }, setInt func(int64) error) error

+ type Abouter interface

+ About func(ctx context.Context) (*Usage, error)

+ type BaseOption Option

+ type Bits uint64

+ func (b *Bits[C]) MarshalJSON() ([]byte, error)

+ func (b *Bits[C]) Scan(s fmt.ScanState, ch rune) error

+ func (b *Bits[C]) Set(s string) error

+ func (b *Bits[C]) UnmarshalJSON(in []byte) error

+ func (b Bits[C]) Choices() []BitsChoicesInfo

+ func (b Bits[C]) Help() string

+ func (b Bits[C]) IsSet(mask Bits[C]) bool

+ func (b Bits[C]) String() string

+ func (b Bits[C]) Type() string

+ type BitsChoices interface

+ Choices func() []BitsChoicesInfo

+ type BitsChoicesInfo struct

+ Bit uint64

+ Name string

+ type BwPair struct

+ Rx SizeSuffix

+ Tx SizeSuffix

+ func (bp *BwPair) IsSet() bool

+ func (bp *BwPair) Set(s string) (err error)

+ func (bp *BwPair) String() string

+ type BwTimeSlot struct

+ Bandwidth BwPair

+ DayOfTheWeek int

+ HHMM int

+ type BwTimetable []BwTimeSlot

+ func (x *BwTimetable) Set(s string) error

+ func (x *BwTimetable) UnmarshalJSON(in []byte) error

+ func (x BwTimetable) LimitAt(tt time.Time) BwTimeSlot

+ func (x BwTimetable) MarshalJSON() ([]byte, error)

+ func (x BwTimetable) String() string

+ func (x BwTimetable) Type() string

+ type ChangeNotifier interface

+ ChangeNotify func(context.Context, func(string, EntryType), <-chan time.Duration)

+ type Choices interface

+ Choices func() []string

+ type ChunkOption struct

+ ChunkSize int64

+ func (o *ChunkOption) Header() (key string, value string)

+ func (o *ChunkOption) Mandatory() bool

+ func (o *ChunkOption) String() string

+ type ChunkWriter interface

+ Abort func(ctx context.Context) error

+ Close func(ctx context.Context) error

+ WriteChunk func(ctx context.Context, chunkNumber int, reader io.ReadSeeker) (bytesWritten int64, err error)

+ type ChunkWriterInfo struct

+ ChunkSize int64

+ Concurrency int

+ LeavePartsOnError bool

+ type CleanUpper interface

+ CleanUp func(ctx context.Context) error

+ type CommaSepList []string

+ func (CommaSepList) Type() string

+ func (l *CommaSepList) Scan(s fmt.ScanState, ch rune) error

+ func (l *CommaSepList) Set(s string) error

+ func (l CommaSepList) String() string

+ type CommandHelp struct

+ Long string

+ Name string

+ Opts map[string]string

+ Short string

+ type Commander interface

+ Command func(ctx context.Context, name string, arg []string, opt map[string]string) (any, error)

+ type ConfigIn struct

+ Result string

+ State string

+ type ConfigInfo struct

+ AskPassword bool

+ AutoConfirm bool

+ BackupDir string

+ BindAddr net.IP

+ BufferSize SizeSuffix

+ BwLimit BwTimetable

+ BwLimitFile BwTimetable

+ CaCert []string

+ CheckFirst bool

+ CheckSum bool

+ Checkers int

+ ClientCert string

+ ClientKey string

+ CompareDest []string

+ ConnectTimeout time.Duration

+ Cookie bool

+ CopyDest []string

+ CutoffMode CutoffMode

+ DataRateUnit string

+ DefaultTime Time

+ DeleteMode DeleteMode

+ DisableFeatures []string

+ DisableHTTP2 bool

+ DisableHTTPKeepAlives bool

+ DownloadHeaders []*HTTPOption

+ DryRun bool

+ Dump DumpFlags

+ ErrorOnNoTransfer bool

+ ExpectContinueTimeout time.Duration

+ FixCase bool

+ FsCacheExpireDuration time.Duration

+ FsCacheExpireInterval time.Duration

+ Headers []*HTTPOption

+ HumanReadable bool

+ IgnoreCaseSync bool

+ IgnoreChecksum bool

+ IgnoreErrors bool

+ IgnoreExisting bool

+ IgnoreSize bool

+ IgnoreTimes bool

+ Immutable bool

+ Inplace bool

+ InsecureSkipVerify bool

+ Interactive bool

+ KvLockTime time.Duration

+ Links bool

+ LogLevel LogLevel

+ LowLevelRetries int

+ MaxBacklog int

+ MaxDelete int64

+ MaxDeleteSize SizeSuffix

+ MaxDepth int

+ MaxDuration time.Duration

+ MaxStatsGroups int

+ MaxTransfer SizeSuffix

+ Metadata bool

+ MetadataMapper SpaceSepList

+ MetadataSet Metadata

+ ModifyWindow time.Duration

+ MultiThreadChunkSize SizeSuffix

+ MultiThreadCutoff SizeSuffix

+ MultiThreadSet bool

+ MultiThreadStreams int

+ MultiThreadWriteBufferSize SizeSuffix

+ NoCheckDest bool

+ NoConsole bool

+ NoGzip bool

+ NoTraverse bool

+ NoUnicodeNormalization bool

+ NoUpdateDirModTime bool

+ NoUpdateModTime bool

+ OrderBy string

+ PartialSuffix string

+ PasswordCommand SpaceSepList

+ Progress bool

+ ProgressTerminalTitle bool

+ RefreshTimes bool

+ Retries int

+ RetriesInterval time.Duration

+ ServerSideAcrossConfigs bool

+ SizeOnly bool

+ StatsFileNameLength int

+ StatsLogLevel LogLevel

+ StatsOneLine bool

+ StatsOneLineDate bool

+ StatsOneLineDateFormat string

+ StreamingUploadCutoff SizeSuffix

+ Suffix string

+ SuffixKeepExtension bool

+ TPSLimit float64

+ TPSLimitBurst int

+ TerminalColorMode TerminalColorMode

+ Timeout time.Duration

+ TrackRenames bool

+ TrackRenamesStrategy string

+ TrafficClass uint8

+ Transfers int

+ UpdateOlder bool

+ UploadHeaders []*HTTPOption

+ UseJSONLog bool

+ UseListR bool

+ UseMmap bool

+ UseServerModTime bool

+ UserAgent string

+ func AddConfig(ctx context.Context) (context.Context, *ConfigInfo)

+ func GetConfig(ctx context.Context) *ConfigInfo

+ func (ci *ConfigInfo) Reload(ctx context.Context) error

+ func (ci *ConfigInfo) TimeoutOrInfinite() time.Duration

+ type ConfigOut struct

+ Error string

+ OAuth any

+ Option *Option

+ Result string

+ State string

+ func BackendConfig(ctx context.Context, name string, m configmap.Mapper, ri *RegInfo, ...) (out *ConfigOut, err error)

+ func ConfigChoose(state string, name string, help string, n int, ...) (*ConfigOut, error)

+ func ConfigChooseExclusive(state string, name string, help string, n int, ...) (*ConfigOut, error)

+ func ConfigChooseExclusiveFixed(state string, name string, help string, items []OptionExample) (*ConfigOut, error)

+ func ConfigChooseFixed(state string, name string, help string, items []OptionExample) (*ConfigOut, error)

+ func ConfigConfirm(state string, Default bool, name string, help string) (*ConfigOut, error)

+ func ConfigError(state string, Error string) (*ConfigOut, error)

+ func ConfigGoto(state string) (*ConfigOut, error)

+ func ConfigInput(state string, name string, help string) (*ConfigOut, error)

+ func ConfigInputOptional(state string, name string, help string) (*ConfigOut, error)

+ func ConfigPassword(state string, name string, help string) (*ConfigOut, error)

+ func ConfigResult(state, result string) (*ConfigOut, error)

+ type Copier interface

+ Copy func(ctx context.Context, src Object, remote string) (Object, error)

+ type CountSuffix int64

+ func (x *CountSuffix) Scan(s fmt.ScanState, ch rune) error

+ func (x *CountSuffix) Set(s string) error

+ func (x *CountSuffix) UnmarshalJSON(in []byte) error

+ func (x CountSuffix) String() string

+ func (x CountSuffix) Type() string

+ func (x CountSuffix) Unit(unit string) string

+ type CountSuffixList []CountSuffix

+ func (l CountSuffixList) Len() int

+ func (l CountSuffixList) Less(i, j int) bool

+ func (l CountSuffixList) Sort()

+ func (l CountSuffixList) Swap(i, j int)

+ type CutoffMode = Enum[cutoffModeChoices]

+ const CutoffModeCautious

+ const CutoffModeDefault

+ const CutoffModeHard

+ const CutoffModeSoft

+ type DeleteMode byte

+ const DeleteModeAfter

+ const DeleteModeBefore

+ const DeleteModeDefault

+ const DeleteModeDuring

+ const DeleteModeOff

+ const DeleteModeOnly

+ type Dir struct

+ func NewDir(remote string, modTime time.Time) *Dir

+ func NewDirCopy(ctx context.Context, d Directory) *Dir

+ func (d *Dir) Fs() Info

+ func (d *Dir) ID() string

+ func (d *Dir) Items() int64

+ func (d *Dir) ModTime(ctx context.Context) time.Time

+ func (d *Dir) ParentID() string

+ func (d *Dir) Remote() string

+ func (d *Dir) SetID(id string) *Dir

+ func (d *Dir) SetItems(items int64) *Dir

+ func (d *Dir) SetParentID(parent string) *Dir

+ func (d *Dir) SetRemote(remote string) *Dir

+ func (d *Dir) SetSize(size int64) *Dir

+ func (d *Dir) Size() int64

+ func (d *Dir) String() string

+ type DirCacheFlusher interface

+ DirCacheFlush func()

+ type DirEntries []DirEntry

+ func (ds DirEntries) ForDir(fn func(dir Directory))

+ func (ds DirEntries) ForDirError(fn func(dir Directory) error) error

+ func (ds DirEntries) ForObject(fn func(o Object))

+ func (ds DirEntries) ForObjectError(fn func(o Object) error) error

+ func (ds DirEntries) Len() int

+ func (ds DirEntries) Less(i, j int) bool

+ func (ds DirEntries) Swap(i, j int)

+ type DirEntry interface

+ Fs func() Info

+ ModTime func(context.Context) time.Time

+ Remote func() string

+ Size func() int64

+ String func() string

+ type DirMover interface

+ DirMove func(ctx context.Context, src Fs, srcRemote, dstRemote string) error

+ type DirSetModTimer interface

+ DirSetModTime func(ctx context.Context, dir string, modTime time.Time) error

+ type DirWrapper struct

+ func NewDirWrapper(remote string, d Directory) *DirWrapper

+ func NewLimitedDirWrapper(remote string, d Directory) *DirWrapper

+ func (d *DirWrapper) Metadata(ctx context.Context) (Metadata, error)

+ func (d *DirWrapper) Remote() string

+ func (d *DirWrapper) SetMetadata(ctx context.Context, metadata Metadata) error

+ func (d *DirWrapper) SetModTime(ctx context.Context, t time.Time) error

+ func (d *DirWrapper) SetRemote(remote string) *DirWrapper

+ func (d *DirWrapper) String() string

+ type Directory interface

+ ID func() string

+ Items func() int64

+ type Disconnecter interface

+ Disconnect func(ctx context.Context) error

+ type DumpFlags = Bits[dumpChoices]

+ const DumpAuth

+ const DumpBodies

+ const DumpFilters

+ const DumpGoRoutines

+ const DumpHeaders

+ const DumpMapper

+ const DumpOpenFiles

+ const DumpRequests

+ const DumpResponses

+ type Duration time.Duration

+ func (d *Duration) Scan(s fmt.ScanState, ch rune) error

+ func (d *Duration) Set(s string) error

+ func (d *Duration) UnmarshalJSON(in []byte) error

+ func (d Duration) IsSet() bool

+ func (d Duration) ReadableString() string

+ func (d Duration) ShortReadableString() string

+ func (d Duration) String() string

+ func (d Duration) Type() string

+ type EntryType int

+ const EntryDirectory

+ const EntryObject

+ type Enum byte

+ func (e *Enum[C]) MarshalJSON() ([]byte, error)

+ func (e *Enum[C]) Scan(s fmt.ScanState, ch rune) error

+ func (e *Enum[C]) Set(s string) error

+ func (e *Enum[C]) UnmarshalJSON(in []byte) error

+ func (e Enum[C]) Choices() []string

+ func (e Enum[C]) Help() string

+ func (e Enum[C]) String() string

+ func (e Enum[C]) Type() string

+ type Features struct

+ About func(ctx context.Context) (*Usage, error)

+ BucketBased bool

+ BucketBasedRootOK bool

+ CanHaveEmptyDirectories bool

+ CaseInsensitive bool

+ ChangeNotify func(context.Context, func(string, EntryType), <-chan time.Duration)

+ ChunkWriterDoesntSeek bool

+ CleanUp func(ctx context.Context) error

+ Command func(ctx context.Context, name string, arg []string, opt map[string]string) (any, error)

+ Copy func(ctx context.Context, src Object, remote string) (Object, error)

+ DirCacheFlush func()

+ DirModTimeUpdatesOnWrite bool

+ DirMove func(ctx context.Context, src Fs, srcRemote, dstRemote string) error

+ DirSetModTime func(ctx context.Context, dir string, modTime time.Time) error

+ Disconnect func(ctx context.Context) error

+ DoubleSlash bool

+ DuplicateFiles bool

+ FilterAware bool

+ GetTier bool

+ IsLocal bool

+ ListR ListRFn

+ MergeDirs func(ctx context.Context, dirs []Directory) error

+ MkdirMetadata func(ctx context.Context, dir string, metadata Metadata) (Directory, error)

+ Move func(ctx context.Context, src Object, remote string) (Object, error)

+ NoMultiThreading bool

+ OpenChunkWriter func(ctx context.Context, remote string, src ObjectInfo, options ...OpenOption) (info ChunkWriterInfo, writer ChunkWriter, err error)

+ OpenWriterAt func(ctx context.Context, remote string, size int64) (WriterAtCloser, error)

+ Overlay bool

+ PartialUploads bool

+ PublicLink func(ctx context.Context, remote string, expire Duration, unlink bool) (string, error)

+ Purge func(ctx context.Context, dir string) error

+ PutStream func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) (Object, error)

+ PutUnchecked func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) (Object, error)

+ ReadDirMetadata bool

+ ReadMetadata bool

+ ReadMimeType bool

+ ServerSideAcrossConfigs bool

+ SetTier bool

+ SetWrapper func(f Fs)

+ Shutdown func(ctx context.Context) error

+ SlowHash bool

+ SlowModTime bool

+ UnWrap func() Fs

+ UserDirMetadata bool

+ UserInfo func(ctx context.Context) (map[string]string, error)

+ UserMetadata bool

+ WrapFs func() Fs

+ WriteDirMetadata bool

+ WriteDirSetModTime bool

+ WriteMetadata bool

+ WriteMimeType bool

+ func (ft *Features) Disable(name string) *Features

+ func (ft *Features) DisableList(list []string) *Features

+ func (ft *Features) Enabled() (features map[string]bool)

+ func (ft *Features) Fill(ctx context.Context, f Fs) *Features

+ func (ft *Features) List() (out []string)

+ func (ft *Features) Mask(ctx context.Context, f Fs) *Features

+ func (ft *Features) Wrap(f Fs) *Features

+ func (ft *Features) WrapsFs(f Fs, w Fs) *Features

+ type Flagger interface

+ Set func(string) error

+ String func() string

+ Type func() string

+ type FlaggerNP interface

+ String func() string

+ Type func() string

+ type Fs interface

+ List func(ctx context.Context, dir string) (entries DirEntries, err error)

+ Mkdir func(ctx context.Context, dir string) error

+ NewObject func(ctx context.Context, remote string) (Object, error)

+ Put func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) (Object, error)

+ Rmdir func(ctx context.Context, dir string) error

+ func NewFs(ctx context.Context, path string) (Fs, error)

+ func TemporaryLocalFs(ctx context.Context) (Fs, error)

+ func UnWrapFs(f Fs) Fs

+ type FullDirectory interface

+ type FullObject interface

+ type FullObjectInfo interface

+ type GetTierer interface

+ GetTier func() string

+ type HTTPOption struct

+ Key string

+ Value string

+ func (o *HTTPOption) Header() (key string, value string)

+ func (o *HTTPOption) Mandatory() bool

+ func (o *HTTPOption) String() string

+ type HashesOption struct

+ Hashes hash.Set

+ func (o *HashesOption) Header() (key string, value string)

+ func (o *HashesOption) Mandatory() bool

+ func (o *HashesOption) String() string

+ type IDer interface

+ ID func() string

+ type Info interface

+ Features func() *Features

+ Hashes func() hash.Set

+ Name func() string

+ Precision func() time.Duration

+ Root func() string

+ String func() string

+ var Unknown Info = unknownFs{}

+ type ListRCallback func(entries DirEntries) error

+ type ListRFn func(ctx context.Context, dir string, callback ListRCallback) error

+ type ListRer interface

+ ListR func(ctx context.Context, dir string, callback ListRCallback) error

+ type LogLevel = Enum[logLevelChoices]

+ const LogLevelAlert

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelEmergency

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelNotice

+ const LogLevelWarning

+ type LogValueItem struct

+ func LogValue(key string, value any) LogValueItem

+ func LogValueHide(key string, value any) LogValueItem

+ func (j LogValueItem) String() string

+ type MergeDirser interface

+ MergeDirs func(ctx context.Context, dirs []Directory) error

+ type Metadata map[string]string

+ func GetMetadata(ctx context.Context, o DirEntry) (metadata Metadata, err error)

+ func GetMetadataOptions(ctx context.Context, dstFs Fs, o DirEntry, options []OpenOption) (metadata Metadata, err error)

+ func (m *Metadata) Merge(other Metadata)

+ func (m *Metadata) MergeOptions(options []OpenOption)

+ func (m *Metadata) Set(k, v string)

+ type MetadataHelp struct

+ Example string

+ Help string

+ ReadOnly bool

+ Type string

+ type MetadataInfo struct

+ Help string

+ System map[string]MetadataHelp

+ type MetadataOption Metadata

+ func (o MetadataOption) Header() (key string, value string)

+ func (o MetadataOption) Mandatory() bool

+ func (o MetadataOption) String() string

+ type Metadataer interface

+ Metadata func(ctx context.Context) (Metadata, error)

+ type MimeTyper interface

+ MimeType func(ctx context.Context) string

+ type MkdirMetadataer interface

+ MkdirMetadata func(ctx context.Context, dir string, metadata Metadata) (Directory, error)

+ type Mover interface

+ Move func(ctx context.Context, src Object, remote string) (Object, error)

+ type NullOption struct

+ func (o NullOption) Header() (key string, value string)

+ func (o NullOption) Mandatory() bool

+ func (o NullOption) String() string

+ type Object interface

+ Open func(ctx context.Context, options ...OpenOption) (io.ReadCloser, error)

+ Remove func(ctx context.Context) error

+ SetModTime func(ctx context.Context, t time.Time) error

+ Update func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) error

+ func UnWrapObject(o Object) Object

+ func UnWrapObjectInfo(oi ObjectInfo) Object

+ type ObjectInfo interface

+ Hash func(ctx context.Context, ty hash.Type) (string, error)

+ Storable func() bool

+ type ObjectPair struct

+ Dst Object

+ Src Object

+ type ObjectUnWrapper interface

+ UnWrap func() Object

+ type Objects []Object

+ type ObjectsChan chan Object

+ type OpenChunkWriter interface

+ OpenChunkWriter func(ctx context.Context, remote string, src ObjectInfo, options ...OpenOption) (info ChunkWriterInfo, writer ChunkWriter, err error)

+ type OpenChunkWriterFn func(ctx context.Context, remote string, src ObjectInfo, options ...OpenOption) (info ChunkWriterInfo, writer ChunkWriter, err error)

+ type OpenOption interface

+ Header func() (key string, value string)

+ Mandatory func() bool

+ func MetadataAsOpenOptions(ctx context.Context) (options []OpenOption)

+ type OpenWriterAtFn func(ctx context.Context, remote string, size int64) (WriterAtCloser, error)

+ type OpenWriterAter interface

+ OpenWriterAt func(ctx context.Context, remote string, size int64) (WriterAtCloser, error)

+ type Option struct

+ Advanced bool

+ Default any

+ Examples OptionExamples

+ Exclusive bool

+ FieldName string

+ Groups string

+ Help string

+ Hide OptionVisibility

+ IsPassword bool

+ Name string

+ NoPrefix bool

+ Provider string

+ Required bool

+ Sensitive bool

+ ShortOpt string

+ Value any

+ func (o *Option) Copy() *Option

+ func (o *Option) EnvVarName(prefix string) string

+ func (o *Option) FlagName(prefix string) string

+ func (o *Option) GetValue() any

+ func (o *Option) IsDefault() bool

+ func (o *Option) MarshalJSON() ([]byte, error)

+ func (o *Option) Set(s string) (err error)

+ func (o *Option) String() string

+ func (o *Option) Type() string

+ type OptionExample struct

+ Help string

+ Provider string

+ Value string

+ type OptionExamples []OptionExample

+ func (os OptionExamples) Len() int

+ func (os OptionExamples) Less(i, j int) bool

+ func (os OptionExamples) Sort()

+ func (os OptionExamples) Swap(i, j int)

+ type OptionVisibility byte

+ const OptionHideBoth

+ const OptionHideCommandLine

+ const OptionHideConfigurator

+ type Options []Option

+ func (os Options) Add(newOptions Options) Options

+ func (os Options) AddPrefix(newOptions Options, prefix string, groups string) Options

+ func (os Options) Get(name string) *Option

+ func (os Options) HasAdvanced() bool

+ func (os Options) NonDefault(m configmap.Getter) configmap.Simple

+ func (os Options) Overridden(m *configmap.Map) configmap.Simple

+ func (os Options) SetDefault(name string, def any) Options

+ type OptionsInfo struct

+ Name string

+ Opt any

+ Options Options

+ Reload func(context.Context) error

+ func (oi *OptionsInfo) Check() error

+ type OverrideDirectory struct

+ func NewOverrideDirectory(oi Directory, remote string) *OverrideDirectory

+ func (o *OverrideDirectory) Remote() string

+ func (o *OverrideDirectory) String() string

+ type OverrideRemote struct

+ func NewOverrideRemote(oi ObjectInfo, remote string) *OverrideRemote

+ func (o *OverrideRemote) GetTier() string

+ func (o *OverrideRemote) ID() string

+ func (o *OverrideRemote) Metadata(ctx context.Context) (Metadata, error)

+ func (o *OverrideRemote) MimeType(ctx context.Context) string

+ func (o *OverrideRemote) Remote() string

+ func (o *OverrideRemote) String() string

+ func (o *OverrideRemote) UnWrap() Object

+ type Pacer struct

+ func NewPacer(ctx context.Context, c pacer.Calculator) *Pacer

+ func (p *Pacer) ModifyCalculator(f func(pacer.Calculator))

+ func (p *Pacer) SetCalculator(c pacer.Calculator)

+ type ParentIDer interface

+ ParentID func() string

+ type PublicLinker interface

+ PublicLink func(ctx context.Context, remote string, expire Duration, unlink bool) (string, error)

+ type Purger interface

+ Purge func(ctx context.Context, dir string) error

+ type PutStreamer interface

+ PutStream func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) (Object, error)

+ type PutUncheckeder interface

+ PutUnchecked func(ctx context.Context, in io.Reader, src ObjectInfo, options ...OpenOption) (Object, error)

+ type RangeOption struct

+ End int64

+ Start int64

+ func ParseRangeOption(s string) (po *RangeOption, err error)

+ func (o *RangeOption) Decode(size int64) (offset, limit int64)

+ func (o *RangeOption) Header() (key string, value string)

+ func (o *RangeOption) Mandatory() bool

+ func (o *RangeOption) String() string

+ type RangeSeeker interface

+ RangeSeek func(ctx context.Context, offset int64, whence int, length int64) (int64, error)

+ type RegInfo struct

+ Aliases []string

+ CommandHelp []CommandHelp

+ Config func(ctx context.Context, name string, m configmap.Mapper, configIn ConfigIn) (*ConfigOut, error)

+ Description string

+ Hide bool

+ MetadataInfo *MetadataInfo

+ Name string

+ NewFs func(ctx context.Context, name string, root string, config configmap.Mapper) (Fs, error)

+ Options Options

+ Prefix string

+ func ConfigFs(path string) (fsInfo *RegInfo, configName, fsPath string, config *configmap.Map, err error)

+ func Find(name string) (*RegInfo, error)

+ func FindFromFs(f Fs) *RegInfo

+ func MustFind(name string) *RegInfo

+ func ParseRemote(path string) (fsInfo *RegInfo, configName, fsPath string, ...)

+ func (ri *RegInfo) FileName() string

+ type SeekOption struct

+ Offset int64

+ func (o *SeekOption) Header() (key string, value string)

+ func (o *SeekOption) Mandatory() bool

+ func (o *SeekOption) String() string

+ type SetMetadataer interface

+ SetMetadata func(ctx context.Context, metadata Metadata) error

+ type SetModTimer interface

+ SetModTime func(ctx context.Context, t time.Time) error

+ type SetTierer interface

+ SetTier func(tier string) error

+ type Shutdowner interface

+ Shutdown func(ctx context.Context) error

+ type SizeSuffix int64

+ const Exbi

+ const Gibi

+ const Kibi

+ const Mebi

+ const Pebi

+ const SizeSuffixBase

+ const Tebi

+ func (x *SizeSuffix) Scan(s fmt.ScanState, ch rune) error

+ func (x *SizeSuffix) Set(s string) error

+ func (x *SizeSuffix) UnmarshalJSON(in []byte) error

+ func (x SizeSuffix) BitRateUnit() string

+ func (x SizeSuffix) BitUnit() string

+ func (x SizeSuffix) ByteRateUnit() string

+ func (x SizeSuffix) ByteUnit() string

+ func (x SizeSuffix) String() string

+ func (x SizeSuffix) Type() string

+ type SizeSuffixList []SizeSuffix

+ func (l SizeSuffixList) Len() int

+ func (l SizeSuffixList) Less(i, j int) bool

+ func (l SizeSuffixList) Sort()

+ func (l SizeSuffixList) Swap(i, j int)

+ type SpaceSepList []string

+ func (SpaceSepList) Type() string

+ func (l *SpaceSepList) Scan(s fmt.ScanState, ch rune) error

+ func (l *SpaceSepList) Set(s string) error

+ func (l SpaceSepList) String() string

+ type TerminalColorMode = Enum[terminalColorModeChoices]

+ const TerminalColorModeAlways

+ const TerminalColorModeAuto

+ const TerminalColorModeNever

+ type Time time.Time

+ func (t *Time) Scan(s fmt.ScanState, ch rune) error

+ func (t *Time) Set(s string) error

+ func (t *Time) UnmarshalJSON(in []byte) error

+ func (t Time) IsSet() bool

+ func (t Time) MarshalJSON() ([]byte, error)

+ func (t Time) String() string

+ func (t Time) Type() string

+ type Tristate struct

+ Valid bool

+ Value bool

+ func (Tristate) Type() string

+ func (t *Tristate) MarshalJSON() ([]byte, error)

+ func (t *Tristate) Scan(s fmt.ScanState, ch rune) error

+ func (t *Tristate) Set(s string) error

+ func (t *Tristate) UnmarshalJSON(in []byte) error

+ func (t Tristate) String() string

+ type UnWrapper interface

+ UnWrap func() Fs

+ type Usage struct

+ Free *int64

+ Objects *int64

+ Other *int64

+ Total *int64

+ Trashed *int64

+ Used *int64

+ type UserInfoer interface

+ UserInfo func(ctx context.Context) (map[string]string, error)

+ type Wrapper interface

+ SetWrapper func(f Fs)

+ WrapFs func() Fs

+ type WriterAtCloser interface

v1.69.1-4

Mar 12, 2025

v1.69.1-3

Mar 12, 2025

v1.69.1-2

Mar 12, 2025