Struct SshServerBuilder

pub struct SshServerBuilder { /* private fields */ }

Builder for the ssh server.

Example

use ssh_test_server::{SshServerBuilder, User};

let _ssh = SshServerBuilder::default()
    .add_user(User::new_admin("root", "pass123"))
    .run()
    .await
    .unwrap();

Implementations

impl SshServerBuilder

pub fn add_user(self, user: User) -> Self

Add a user to ssh server.

Example

let _ssh = SshServerBuilder::default()
    .add_user(User::new_admin("root", "pass"))
    .add_user(User::new("luiza", "obrazy"))
    .run()
    .await
    .unwrap();

pub fn add_users(self, users: &[User]) -> Self

Add list of users.

let users = vec![User::new("a", "p"), User::new("b", "p")];
let _ssh = SshServerBuilder::default()
    .add_users(&users)
    .run()
    .await
    .unwrap();

pub fn add_program(self, program: &str, handler: Box<SshExecuteHandler>) -> Self

Add custom command/program.

Example

fn cmd_print_message(
    context: &SshExecuteContext,
    program: &str,
    args: &[&str],
) -> SshExecuteResult {
    let stdout = format!(
        "Program {program} run by {} has {} args.",
        context.current_user,
        args.len()
    );
    SshExecuteResult::stdout(0, stdout)
}

let _ssh = SshServerBuilder::default()
    .add_program("print_message", Box::new(cmd_print_message))
    .run()
    .await
    .unwrap();

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

Listen on address.

Example

let _ssh = SshServerBuilder::default()
    .bind_addr("127.0.0.1")
    .run()
    .await
    .unwrap();

pub fn port(self, port: u16) -> Self

Listen on port.

Example

let _ssh = SshServerBuilder::default()
    .port(9992)
    .run()
    .await
    .unwrap();

pub async fn run(self) -> Result<SshServer>

Build and run the ssh server.

Server stops when SshServer is dropped.

Trait Implementations

impl Default for SshServerBuilder

fn default() -> SshServerBuilder

Returns the “default value” for a type.