Struct Config 

pub struct Config {
    pub listen_interface: Option<String>,
    pub endpoint_interface: Option<String>,
    pub port: u16,
    pub buffer_size: usize,
    pub read_timeout: u64,
    pub accept_cidr: String,
}

A super basic SOCKS5 proxy.

Every option can be supplied as a CLI flag or via its RS_* environment variable; flags win.

Fields

listen_interface: Option<String>

Network interface whose IP the proxy listens on (defaults to 0.0.0.0).

endpoint_interface: Option<String>

Network interface whose IP is used for outbound connections to endpoints (defaults to 0.0.0.0).

port: u16

Port to listen on.

buffer_size: usize

Per-direction buffer size, in bytes.

read_timeout: u64

Idle timeout in milliseconds: a connection with no traffic in either direction for this long is closed. 0 disables the idle timeout entirely.

accept_cidr: String

CIDR of client addresses allowed to connect.

Implementations

impl Config

pub fn listen_ip(&self) -> Res<String>

Resolve the listen IP from the configured interface, defaulting to 0.0.0.0.

pub fn endpoint_ip(&self) -> Res<String>

Resolve the endpoint (outbound) IP from the configured interface, defaulting to 0.0.0.0.

Trait Implementations

impl Args for Config

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Config

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Config

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

Formats the value using the given formatter.

impl FromArgMatches for Config

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 Parser for Config

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.