Struct rustic_backend::opendal::sftp::SftpBackend

pub struct SftpBackend(/* private fields */);

Implementations

impl SftpBackend

pub fn new( path: impl AsRef<str>, options: HashMap<String, String> ) -> Result<Self>

Create a new SFTP backend.

Arguments

• path - The path to the sftp server
• options - Additional options for the SFTP backend

Notes

The path should be something like “sftp://user@host:port/path”

pub fn to_inner(self) -> OpenDALBackend

Trait Implementations

impl Clone for SftpBackend

fn clone(&self) -> SftpBackend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SftpBackend

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

Formats the value using the given formatter.

impl ReadBackend for SftpBackend

fn location(&self) -> String

Returns the location of the backend.

fn list(&self, tpe: FileType) -> Result<Vec<Id>>

Lists all files of the given type.

fn list_with_size(&self, tpe: FileType) -> Result<Vec<(Id, u32)>>

Lists all files with their size of the given type.

fn read_full(&self, tpe: FileType, id: &Id) -> Result<Bytes>

Reads full data of the given file.

fn read_partial( &self, tpe: FileType, id: &Id, cacheable: bool, offset: u32, length: u32 ) -> Result<Bytes>

Reads partial data of the given file.

fn needs_warm_up(&self) -> bool

Specify if the backend needs a warming-up of files before accessing them.

fn warm_up(&self, _tpe: FileType, _id: &Id) -> Result<(), Error>

Warm-up the given file.

impl WriteBackend for SftpBackend

fn create(&self) -> Result<()>

Creates a new backend.

fn write_bytes( &self, tpe: FileType, id: &Id, cacheable: bool, buf: Bytes ) -> Result<()>

Writes bytes to the given file.

fn remove(&self, tpe: FileType, id: &Id, cacheable: bool) -> Result<()>

Removes the given file.