Documentation ¶
Index ¶
- func NewFs(name string, rootleaf string, config configmap.Mapper) (fs.Fs, error)
- type DownloadRequest
- type EndFileUploadResponse
- type File
- type FilesList
- type Folder
- type FoldersList
- type Fs
- func (f *Fs) CreateDir(ctx context.Context, pathID, leaf string) (newID string, err error)
- func (f *Fs) Features() *fs.Features
- func (f *Fs) FindLeaf(ctx context.Context, pathID, leaf string) (pathIDOut string, found bool, err error)
- 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) Name() string
- func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)
- func (f *Fs) Precision() time.Duration
- func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
- func (f *Fs) PutUnchecked(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 GenericOKResponse
- type GetTokenResponse
- type GetUploadNodeResponse
- type ListFilesRequest
- type ListFolderRequest
- type MakeFolderRequest
- type MakeFolderResponse
- type Object
- func (o *Object) Fs() fs.Info
- func (o *Object) Hash(ctx context.Context, t hash.Type) (string, error)
- func (o *Object) ID() string
- func (o *Object) MimeType(ctx context.Context) string
- func (o *Object) ModTime(ctx context.Context) time.Time
- func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (io.ReadCloser, error)
- func (o *Object) Remote() string
- func (o *Object) Remove(ctx context.Context) error
- func (o *Object) SetModTime(context.Context, 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) error
- type Options
- type RemoveFileRequest
- type RemoveFolderRequest
- type RmFile
- type SharedFile
- type SharedFolderResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type DownloadRequest ¶
DownloadRequest is the request structure of the corresponding request
type EndFileUploadResponse ¶
type EndFileUploadResponse struct { Incoming int `json:"incoming"` Links []struct { Download string `json:"download"` Filename string `json:"filename"` Remove string `json:"remove"` Size string `json:"size"` Whirlpool string `json:"whirlpool"` } `json:"links"` }
EndFileUploadResponse is the response structure of the corresponding request
type File ¶
type File struct { ACL int `json:"acl"` CDN int `json:"cdn"` Checksum string `json:"checksum"` ContentType string `json:"content-type"` Date string `json:"date"` Filename string `json:"filename"` Pass int `json:"pass"` Size int `json:"size"` URL string `json:"url"` }
File is the structure how 1Fichier returns a File
type Folder ¶
type Folder struct { CreateDate string `json:"create_date"` ID int `json:"id"` Name string `json:"name"` Pass int `json:"pass"` }
Folder is the structure how 1Fichier returns a Folder
type FoldersList ¶
type FoldersList struct { FolderID int `json:"folder_id"` Name string `json:"name"` Status string `json:"Status"` SubFolders []Folder `json:"sub_folders"` }
FoldersList is the structure how 1Fichier returns a list of Folders
type Fs ¶
type Fs struct {
// contains filtered or unexported fields
}
Fs is the interface a cloud storage system must provide
func (*Fs) FindLeaf ¶
func (f *Fs) FindLeaf(ctx context.Context, pathID, leaf string) (pathIDOut string, found bool, err error)
FindLeaf finds a directory of name leaf in the folder with ID pathID
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) Mkdir ¶
Mkdir makes the directory (container, bucket)
Shouldn't return an error if it already exists
func (*Fs) NewObject ¶
NewObject finds the Object at remote. If it can't be found it returns the error ErrorObjectNotFound.
func (*Fs) Put ¶
func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
Put in to the remote path with the modTime given of the given size
When called from outside a Fs by rclone, src.Size() will always be >= 0. But for unknown-sized objects (indicated by src.Size() == -1), Put should either return an error or upload it properly (rather than e.g. calling panic).
May create the object even if it returns an error - if so will return the object and the error, otherwise will return nil and the error
func (*Fs) PutUnchecked ¶
func (f *Fs) PutUnchecked(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
PutUnchecked uploads the object
This will create a duplicate if we upload a new file without checking to see if there is one already - use Put() for that.
type GenericOKResponse ¶
GenericOKResponse is the response structure of the corresponding request
type GetTokenResponse ¶
type GetTokenResponse struct { URL string `json:"url"` Status string `json:"Status"` Message string `json:"Message"` }
GetTokenResponse is the response structure of the corresponding request
type GetUploadNodeResponse ¶
GetUploadNodeResponse is the response structure of the corresponding request
type ListFilesRequest ¶
type ListFilesRequest struct {
FolderID int `json:"folder_id"`
}
ListFilesRequest is the request structure of the corresponding request
type ListFolderRequest ¶
type ListFolderRequest struct {
FolderID int `json:"folder_id"`
}
ListFolderRequest is the request structure of the corresponding request
type MakeFolderRequest ¶
MakeFolderRequest is the request structure of the corresponding request
type MakeFolderResponse ¶
MakeFolderResponse is the response structure of the corresponding request
type Object ¶
type Object struct {
// contains filtered or unexported fields
}
Object is a filesystem like object provided by an Fs
func (*Object) Hash ¶
Hash returns the selected checksum of the file If no checksum is available it returns ""
func (*Object) ModTime ¶
ModTime returns the modification date of the file It should return a best guess if one isn't available
func (*Object) Open ¶
func (o *Object) Open(ctx context.Context, options ...fs.OpenOption) (io.ReadCloser, error)
Open opens the file for read. Call Close() on the returned io.ReadCloser
func (*Object) SetModTime ¶
SetModTime sets the metadata on the object to set the modification date
func (*Object) Update ¶
func (o *Object) Update(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error
Update in to the object with the modTime given of the given size
When called from outside a Fs by rclone, src.Size() will always be >= 0. But for unknown-sized objects (indicated by src.Size() == -1), Upload should either return an error or update the object properly (rather than e.g. calling panic).
type Options ¶
type Options struct { APIKey string `config:"api_key"` }
Options defines the configuration for this backend
type RemoveFileRequest ¶
type RemoveFileRequest struct {
Files []RmFile `json:"files"`
}
RemoveFileRequest is the request structure of the corresponding request
type RemoveFolderRequest ¶
type RemoveFolderRequest struct {
FolderID int `json:"folder_id"`
}
RemoveFolderRequest is the request structure of the corresponding request
type RmFile ¶
type RmFile struct {
URL string `json:"url"`
}
RmFile is the request structure of the corresponding request
type SharedFile ¶
type SharedFile struct {}
SharedFile is the structure how 1Fichier returns a shared File
type SharedFolderResponse ¶
type SharedFolderResponse []SharedFile
SharedFolderResponse is the response structure of the corresponding request