Struct opendal::services::Sftp

pub struct Sftp { /* private fields */ }

Available on crate feature services-sftp only.

SFTP services support. (only works on unix)

If you are interested in working on windows, please refer to this issue. Welcome to leave your comments or make contributions.

Warning: Maximum number of file holdings is depending on the remote system configuration.

For example, the default value is 255 in macOS, and 1024 in linux. If you want to open lots of files, you should pay attention to close the file after using it.

Capabilities

This service can be used to:

• stat
• read
• write
• append
• create_dir
• delete
• copy
• rename
• list
• presign
• blocking

Configuration

• endpoint: Set the endpoint for connection. The format is same as openssh, using either [user@]hostname or ssh://[user@]hostname[:port]. A username or port that is specified in the endpoint overrides the one set in the builder (but does not change the builder).
• root: Set the work directory for backend. It uses the default directory set by the remote sftp-server as default
• user: Set the login user
• key: Set the public key for login
• known_hosts_strategy: Set the strategy for known hosts, default to Strict
• enable_copy: Set whether the remote server has copy-file extension

For security reasons, it doesn’t support password login, you can use public key or ssh-copy-id instead.

You can refer to SftpBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::services::Sftp;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Sftp::default()
        .endpoint("127.0.0.1")
        .user("test")
        .key("test_key");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl SftpBuilder

pub fn endpoint(self, endpoint: &str) -> Self

set endpoint for sftp backend. The format is same as openssh, using either [user@]hostname or ssh://[user@]hostname[:port]. A username or port that is specified in the endpoint overrides the one set in the builder (but does not change the builder).

pub fn root(self, root: &str) -> Self

set root path for sftp backend. It uses the default directory set by the remote sftp-server as default.

pub fn user(self, user: &str) -> Self

set user for sftp backend.

pub fn key(self, key: &str) -> Self

set key path for sftp backend.

pub fn known_hosts_strategy(self, strategy: &str) -> Self

set known_hosts strategy for sftp backend. available values:

• Strict (default)
• Accept
• Add

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

set enable_copy for sftp backend. It requires the server supports copy-file extension.

Trait Implementations

impl Builder for SftpBuilder

const SCHEME: Scheme = Scheme::Sftp

Associated scheme for this builder. It indicates what underlying service is.

type Config = SftpConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for SftpBuilder

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

Formats the value using the given formatter.

impl Default for SftpBuilder

fn default() -> SftpBuilder

Returns the “default value” for a type.