Documentation
¶
Overview ¶
Package webdav provides an interface to the Webdav object storage system.
Index ¶
- Variables
- func NewFs(ctx context.Context, name, root string, m configmap.Mapper) (fs.Fs, error)
- type ClientError
- type Fs
- func (f *Fs) About(ctx context.Context) (*fs.Usage, error)
- func (f *Fs) Copy(ctx context.Context, src fs.Object, remote string) (fs.Object, error)
- func (f *Fs) DirMove(ctx context.Context, src fs.Fs, srcRemote, dstRemote string) error
- func (f *Fs) Features() *fs.Features
- func (f *Fs) Hashes() hash.Set
- func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error)
- func (f *Fs) Mkdir(ctx context.Context, dir string) error
- func (f *Fs) Move(ctx context.Context, src fs.Object, remote string) (fs.Object, error)
- func (f *Fs) Name() string
- func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)
- func (f *Fs) Precision() time.Duration
- func (f *Fs) Purge(ctx context.Context, dir string) error
- func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
- func (f *Fs) PutStream(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
- func (f *Fs) Rmdir(ctx context.Context, dir string) error
- func (f *Fs) Root() string
- func (f *Fs) String() string
- type Metadata
- type Object
- func (o *Object) CreateUploader(ctx context.Context, u *Upload, options ...fs.OpenOption) (*Uploader, error)
- func (o *Object) Fs() fs.Info
- func (o *Object) Hash(ctx context.Context, t hash.Type) (string, error)
- func (o *Object) ModTime(ctx context.Context) time.Time
- func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (in io.ReadCloser, err error)
- func (o *Object) Remote() string
- func (o *Object) Remove(ctx context.Context) error
- func (o *Object) SetModTime(ctx context.Context, modTime time.Time) error
- func (o *Object) Size() int64
- func (o *Object) Storable() bool
- func (o *Object) String() string
- func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (err error)
- type Options
- type Upload
- type Uploader
Constants ¶
This section is empty.
Variables ¶
var ( // ErrChunkSize is returned when the chunk size is zero ErrChunkSize = errors.New("tus chunk size must be greater than zero") // ErrNilLogger is returned when the logger is nil ErrNilLogger = errors.New("tus logger can't be nil") // ErrNilStore is returned when the store is nil ErrNilStore = errors.New("tus store can't be nil if resume is enable") // ErrNilUpload is returned when the upload is nil ErrNilUpload = errors.New("tus upload can't be nil") // ErrLargeUpload is returned when the upload body is to large ErrLargeUpload = errors.New("tus upload body is to large") // ErrVersionMismatch is returned when the tus protocol version is mismatching ErrVersionMismatch = errors.New("tus protocol version mismatch") // ErrOffsetMismatch is returned when the tus upload offset is mismatching ErrOffsetMismatch = errors.New("tus upload offset mismatch") // ErrUploadNotFound is returned when the tus upload is not found ErrUploadNotFound = errors.New("tus upload not found") // ErrResumeNotEnabled is returned when the tus resuming is not enabled ErrResumeNotEnabled = errors.New("tus resuming not enabled") // ErrFingerprintNotSet is returned when the tus fingerprint is not set ErrFingerprintNotSet = errors.New("tus fingerprint not set") )
Functions ¶
Types ¶
type ClientError ¶ added in v1.70.0
ClientError represents an error state of a client
func (ClientError) Error ¶ added in v1.70.0
func (c ClientError) Error() string
Error returns an error string containing the client error code
type Fs ¶
type Fs struct {
// contains filtered or unexported fields
}
Fs represents a remote webdav
func (*Fs) Copy ¶
Copy src to this remote using server-side copy operations.
This is stored with the remote path given.
It returns the destination Object and a possible error.
Will only be called if src.Fs().Name() == f.Name()
If it isn't possible then return fs.ErrorCantCopy
func (*Fs) DirMove ¶
DirMove moves src, srcRemote to this remote at dstRemote using server-side move operations.
Will only be called if src.Fs().Name() == f.Name()
If it isn't possible then return fs.ErrorCantDirMove
If destination exists then return fs.ErrorDirExists
func (*Fs) List ¶
List the objects and directories in dir into entries. The entries can be returned in any order but should be for a complete directory.
dir should be "" to list the root, and should not have trailing slashes.
This should return ErrDirNotFound if the directory isn't found.
func (*Fs) Move ¶
Move src to this remote using server-side move operations.
This is stored with the remote path given.
It returns the destination Object and a possible error.
Will only be called if src.Fs().Name() == f.Name()
If it isn't possible then return fs.ErrorCantMove
func (*Fs) NewObject ¶
NewObject finds the Object at remote. If it can't be found it returns the error fs.ErrorObjectNotFound.
func (*Fs) Purge ¶
Purge deletes all the files in the directory
Optional interface: Only implement this if you have a way of deleting all the files quicker than just running Remove() on the result of List()
func (*Fs) Put ¶
func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
Put the object
Copy the reader in to the new object which is returned.
The new object may have been created if an error is returned
func (*Fs) PutStream ¶
func (f *Fs) PutStream(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
PutStream uploads to the remote path with the modTime given of indeterminate size
type Object ¶
type Object struct {
// contains filtered or unexported fields
}
Object describes a webdav object
Will definitely have info but maybe not meta
func (*Object) CreateUploader ¶ added in v1.70.0
func (o *Object) CreateUploader(ctx context.Context, u *Upload, options ...fs.OpenOption) (*Uploader, error)
CreateUploader creates a new upload to the server.
func (*Object) ModTime ¶
ModTime returns the modification time of the object
It attempts to read the objects mtime and if that isn't present the LastModified returned in the http headers
func (*Object) Open ¶
func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (in io.ReadCloser, err error)
Open an object for read
func (*Object) SetModTime ¶
SetModTime sets the modification time of the local fs object
func (*Object) Update ¶
func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (err error)
Update the object with the contents of the io.Reader, modTime and size
If existing is set then it updates the object rather than creating a new one.
The new object may have been created if an error is returned
type Options ¶
type Options struct {
URL string `config:"url"`
Vendor string `config:"vendor"`
User string `config:"user"`
Pass string `config:"pass"`
BearerToken string `config:"bearer_token"`
BearerTokenCommand string `config:"bearer_token_command"`
Enc encoder.MultiEncoder `config:"encoding"`
Headers fs.CommaSepList `config:"headers"`
PacerMinSleep fs.Duration `config:"pacer_min_sleep"`
ChunkSize fs.SizeSuffix `config:"nextcloud_chunk_size"`
ExcludeMounts bool `config:"owncloud_exclude_mounts"`
UnixSocket string `config:"unix_socket"`
AuthRedirect bool `config:"auth_redirect"`
}
Options defines the configuration for this backend
type Upload ¶ added in v1.70.0
type Upload struct {
Fingerprint string
Metadata Metadata
// contains filtered or unexported fields
}
Upload is a struct containing the file status during upload
func (*Upload) EncodedMetadata ¶ added in v1.70.0
EncodedMetadata encodes the upload metadata.
type Uploader ¶ added in v1.70.0
type Uploader struct {
// contains filtered or unexported fields
}
Uploader holds all information about a currently running upload
func NewUploader ¶ added in v1.70.0
NewUploader creates a new Uploader.
func (*Uploader) NotifyUploadProgress ¶ added in v1.70.0
NotifyUploadProgress subscribes to progress updates.
func (*Uploader) UploadChunk ¶ added in v1.70.0
UploadChunk uploads a single chunk.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api has type definitions for webdav
|
Package api has type definitions for webdav |
|
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint
|
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint |