Struct SftpReceiver 

pub struct SftpReceiver { /* private fields */ }

Implementations

impl SftpReceiver

pub fn new<T: AsRef<str>>(host: T, user: T) -> Self

pub fn on_event<T, Fut>(self, handler: T) -> Self

where T: Fn(SftpReceiverEvent) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

pub fn password<T: AsRef<str>>(self, password: T) -> Self

Sets the password for authentication.

pub fn private_key<T: AsRef<Path>, S: AsRef<str>>( self, key_path: T, passphrase: Option<S>, ) -> Self

Sets the private key path and passphrase for authentication.

pub fn remote_path<T: AsRef<Path>>(self, remote_path: T) -> Self

Sets the remote directory for the user on the sftp server.

pub fn delete_after(self, delete_after: bool) -> Self

Delete the remote file in sftp after successfully downloading it.

pub fn regex<T: AsRef<str>>(self, regex: T) -> Self

Sets the regex filter for what files will be downloaded from the sftp server.

The default regex is: ^.+.[^./\]+$

pub async fn receive_once<T: AsRef<Path>>( self, target_local_path: T, ) -> Result<()>

Download files from the sftp server to the target local path.

Filters for files can be set with regex(), the default regex is: ^.+.[^./\]+$