filesystem

package
v1.0.12 Latest Latest
Warning

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

Go to latest
Published: Jun 10, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package filesystem defines the common FS interface and Listing type shared by Adele's remote storage backends (S3, MinIO, SFTP, and WebDAV).

Each backend implements FS to put, get, list, and delete files using a uniform API, decoupling application code from any specific storage provider.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FS

type FS interface {
	Put(fileName string, folder string, acl ...string) error
	Get(destination string, items ...string) error
	List(prefix string) ([]Listing, error)
	Delete(itemsToDelete []string) bool
}

The interface for the filesystem that must be implemented

type Listing

type Listing struct {
	Etag         string
	LastModified time.Time
	Key          string
	Size         float64
	IsDir        bool
}

Describes one file on a remote file system

Directories

Path Synopsis
Package miniofilesystem implements the filesystem.FS interface backed by MinIO object storage using the minio-go client.
Package miniofilesystem implements the filesystem.FS interface backed by MinIO object storage using the minio-go client.
Package s3filesystem implements the filesystem.FS interface backed by Amazon S3 (and S3-compatible endpoints) using the AWS SDK for Go.
Package s3filesystem implements the filesystem.FS interface backed by Amazon S3 (and S3-compatible endpoints) using the AWS SDK for Go.
Package sftpfilesystem implements the filesystem.FS interface backed by a remote SFTP server over SSH using the pkg/sftp client.
Package sftpfilesystem implements the filesystem.FS interface backed by a remote SFTP server over SSH using the pkg/sftp client.
Package webdavfilesystem implements the filesystem.FS interface backed by a remote WebDAV server using the gowebdav client.
Package webdavfilesystem implements the filesystem.FS interface backed by a remote WebDAV server using the gowebdav client.

Jump to

Keyboard shortcuts

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