Struct FilesystemMountDefinition 

pub struct FilesystemMountDefinition {
    pub id: String,
    pub host: String,
    pub port: u16,
    pub user: String,
    pub mount_options: Vec<String>,
    pub remote_path: String,
    pub mount_dest_path: Option<String>,
    pub cmd_before_mount: String,
    pub auth_type: AuthType,
    pub ssh_key: String,
}

Fields

id: String

Unique identifier for this definition. If mount_dest_path is None, this will also influence where the filesystem gets mounted locally (see local_mount_path()).

host: String

Hostname or IP address of the remote machine

port: u16

Port number of the remote machine (e.g. 22).

user: String

Username to SSH in on the remote machine (e.g. user).

mount_options: Vec<String>

Mount options to pass to sshfs (-o). Example: [follow_symlinks, rename]

remote_path: String

Path on the remote server that will be mounted locally (e.g. /storage).

mount_dest_path: Option<String>

Path where the filesystem will be mounted locally (e.g. /home/user/storage). If not provided, it defaults to {DEFAULT_MOUNT_PATH_PREFIX}/{id}.

cmd_before_mount: String

Command to run before mounting (e.g. /bin/true)

auth_type: AuthType

Authentication method. Most of the potential values match SSH’s PreferredAuthentications list, but some are special values that we recognize & handle here.

ssh_key: String

Path to an SSH private key (e.g. /home/user/.ssh/id_ed25519) for authentication types (like AuthType::PublicKey) that use a key.

Implementations

impl FilesystemMountDefinition

pub fn from_json_string(contents: &str) -> Result<Self, Error>

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

pub fn local_mount_path(&self) -> String

Returns the local mount path for this definition. If mount_dest_path is not None for this definition, it will be used. Otherwise, the default mount path (DEFAULT_MOUNT_PATH_PREFIX) will be used (e.g. /mnt/sshfs/{id}).

pub fn mount_commands(&self) -> Result<Vec<Command>, SftpManError>

Returns a list of commands for mounting the filesystem definition. Mounting is performed via sshfs and ssh commands.

pub fn umount_commands(&self) -> Result<Vec<Command>, SftpManError>

Returns a list of commands for unmounting the filesystem definition.

Unmounting with this command may fail if the filesystem is busy and a fallback mechanism may be necessary (killing the sshfs process responsible for the mount).

pub fn open_command(&self) -> Command

Returns a command that opens a file manager (via xdg-open) at the local mount path (see local_mount_path()).

Opening requires that the filesystem is already mounted.

Trait Implementations

impl Clone for FilesystemMountDefinition

fn clone(&self) -> FilesystemMountDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilesystemMountDefinition

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

Formats the value using the given formatter.

impl Default for FilesystemMountDefinition

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FilesystemMountDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FilesystemMountDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for FilesystemMountDefinition

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for FilesystemMountDefinition

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>