Struct RemoteMachine 

pub struct RemoteMachine {
    pub host: String,
    pub user: Option<String>,
    pub port: Option<u16>,
    pub identity_file: Option<PathBuf>,
    pub freenet_binary: Option<PathBuf>,
    pub work_dir: Option<PathBuf>,
}

Configuration for a remote Linux machine accessible via SSH

Fields

host: String

SSH hostname or IP address

user: Option<String>

SSH username (defaults to current user if None)

port: Option<u16>

SSH port (defaults to 22 if None)

identity_file: Option<PathBuf>

Path to SSH identity file (private key)

freenet_binary: Option<PathBuf>

Path to freenet binary on remote machine (if pre-installed) If None, binary will be deployed via SCP

work_dir: Option<PathBuf>

Working directory for peer data on remote machine Defaults to /tmp/freenet-test-network if None

Implementations

impl RemoteMachine

pub fn new(host: impl Into<String>) -> Self

Create a new remote machine configuration

pub fn user(self, user: impl Into<String>) -> Self

Set the SSH username

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

Set the SSH port

pub fn identity_file(self, path: impl Into<PathBuf>) -> Self

Set the SSH identity file path

pub fn freenet_binary(self, path: impl Into<PathBuf>) -> Self

Set the remote freenet binary path

pub fn work_dir(self, path: impl Into<PathBuf>) -> Self

Set the remote working directory

pub fn ssh_port(&self) -> u16

Get the SSH port (22 if not specified)

pub fn ssh_user(&self) -> String

Get the SSH username (current user if not specified)

pub fn remote_work_dir(&self) -> PathBuf

Get the remote work directory

pub fn connect(&self) -> Result<Session>

Establish an SSH connection to this machine

pub fn exec(&self, command: &str) -> Result<String>

Execute a command on the remote machine and return output

pub fn scp_upload(&self, local_path: &Path, remote_path: &str) -> Result<()>

Copy a local file to the remote machine via SCP

pub fn scp_download(&self, remote_path: &str, local_path: &Path) -> Result<()>

Copy a remote file to the local machine via SCP

pub fn discover_public_address(&self) -> Result<String>

Discover the public IP address of the remote machine

Trait Implementations

impl Clone for RemoteMachine

fn clone(&self) -> RemoteMachine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteMachine

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

Formats the value using the given formatter.