Struct distant::config::ServerListenConfig

pub struct ServerListenConfig {
    pub host: Option<BindAddress>,
    pub port: Option<PortRange>,
    pub use_ipv6: bool,
    pub shutdown_after: Option<f32>,
    pub current_dir: Option<PathBuf>,
}

Fields

host: Option<BindAddress>

Control the IP address that the distant binds to

There are three options here:

1. ssh: the server will reply from the IP address that the SSH connection came from (as found in the SSH_CONNECTION environment variable). This is useful for multihomed servers.

2. any: the server will reply on the default interface and will not bind to a particular IP address. This can be useful if the connection is made through ssh or another tool that makes the SSH connection appear to come from localhost.

3. IP: the server will attempt to bind to the specified IP address.

port: Option<PortRange>

Set the port(s) that the server will attempt to bind to

This can be in the form of PORT1 or PORT1:PORTN to provide a range of ports. With --port 0, the server will let the operating system pick an available TCP port.

Please note that this option does not affect the server-side port used by SSH

use_ipv6: bool

If specified, will bind to the ipv6 interface if host is “any” instead of ipv4

shutdown_after: Option<f32>

The time in seconds before shutting down the server if there are no active connections. The countdown begins once all connections have closed and stops when a new connection is made. In not specified, the server will not shutdown at any point when there are no active connections.

current_dir: Option<PathBuf>

Changes the current working directory (cwd) to the specified directory

Trait Implementations

impl Args for ServerListenConfig

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

impl Debug for ServerListenConfig

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

Formats the value using the given formatter.

impl Default for ServerListenConfig

fn default() -> ServerListenConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerListenConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Map> for ServerListenConfig

fn from(map: Map) -> Self

Converts to this type from the input type.

impl From<ServerListenConfig> for Map

fn from(config: ServerListenConfig) -> Self

Converts to this type from the input type.

impl FromArgMatches for ServerListenConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Serialize for ServerListenConfig

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

Serialize this value into the given Serde serializer.