Struct unftp_sbe_gcs::CloudStorage

pub struct CloudStorage { /* private fields */ }

A StorageBackend that uses Cloud storage from Google. cloned for each controlchan!

Implementations

impl CloudStorage

pub fn new<Str, AuthHow>(bucket: Str, auth: AuthHow) -> Selfwhere
    Str: Into<String>,
    AuthHow: Into<AuthMethod>,

Creates a new Google Cloud Storage backend connected to the specified GCS bucket. The auth parameter specifies how libunftp will authenticate with GCS.

pub fn with_bucket_root<Str, AuthHow>(
    bucket: Str,
    root: PathBuf,
    auth: AuthHow
) -> Selfwhere
    Str: Into<String>,
    AuthHow: Into<AuthMethod>,

Creates a new Google Cloud Storage backend connected to the specified GCS bucket. The auth parameter specifies how libunftp will authenticate with GCS. Files will be placed and looked for in the specified root directory/prefix inside the bucket.

pub fn with_api_base<Str, AuthHow>(
    base_url: Str,
    bucket: Str,
    root: PathBuf,
    auth: AuthHow
) -> Selfwhere
    Str: Into<String>,
    AuthHow: Into<AuthMethod>,

Creates a new Google Cloud Storage backend connected to the specified GCS bucket using GCS API base_url for JSON API requests. Files will be placed and looked for in the specified root directory inside the bucket. The auth parameter specifies how libunftp will authenticate.

Trait Implementations

impl Clone for CloudStorage

fn clone(&self) -> CloudStorage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloudStorage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<User: UserDetail> StorageBackend<User> for CloudStorage

type Metadata = ObjectMetadata

The concrete type of the metadata used by this storage backend.

fn supported_features(&self) -> u32

Tells which optional features are supported by the storage back-end Return a value with bits set according to the FEATURE_* constants.

fn metadata<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<Self::Metadata, Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Returns the Metadata for the given file.

fn md5<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>where
    P: AsRef<Path> + Send + Debug + 'async_trait,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Returns the MD5 hash for the given file.

fn list<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<Vec<Fileinfo<PathBuf, Self::Metadata>>, Error>> + Send + 'async_trait>>where
    <Self as StorageBackend<User>>::Metadata: Metadata,
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Returns the list of files in the given directory.

fn get_into<'a, 'life0, 'life1, 'async_trait, P, W>(
    &'life0 self,
    user: &'life1 User,
    path: P,
    start_pos: u64,
    output: &'a mut W
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where
    W: AsyncWrite + Unpin + Sync + Send + 'async_trait + ?Sized,
    P: AsRef<Path> + Send + Debug + 'async_trait,
    Self: 'async_trait,
    'a: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Gets the content of the given FTP file from offset start_pos file by copying it to the output writer. The starting position will only be greater than zero if the storage back-end implementation advertises to support partial reads through the supported_features method i.e. the result from supported_features yield 1 if a logical and operation is applied with FEATURE_RESTART.

fn get<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P,
    start_pos: u64
) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncRead + Send + Sync + Unpin>, Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Returns the content of the given file from offset start_pos. The starting position will only be greater than zero if the storage back-end implementation advertises to support partial reads through the supported_features method i.e. the result from supported_features yield 1 if a logical and operation is applied with FEATURE_RESTART.

fn put<'life0, 'life1, 'async_trait, P, B>(
    &'life0 self,
    _user: &'life1 User,
    bytes: B,
    path: P,
    _start_pos: u64
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    B: 'async_trait + AsyncRead + Send + Sync + Unpin + 'static,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Writes bytes from the given reader to the specified path starting at offset start_pos in the file

fn del<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Deletes the file at the given path.

fn mkd<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Creates the given directory.

fn rename<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    _from: P,
    _to: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Renames the given file to the given new filename.

fn rmd<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Deletes the given directory.

fn cwd<'life0, 'life1, 'async_trait, P>(
    &'life0 self,
    _user: &'life1 User,
    path: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
    P: 'async_trait + AsRef<Path> + Send + Debug,
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Changes the working directory to the given path.

fn name(&self) -> &str

Implement to set the name of the storage back-end. By default it returns the type signature.