Struct tun2proxy::Args

pub struct Args {

    pub proxy: ArgProxy,
    pub tun: Option<String>,
    pub tun_fd: Option<i32>,
    pub close_fd_on_drop: Option<bool>,
    pub unshare: bool,
    pub unshare_pidfile: Option<String>,
    pub socket_transfer_fd: Option<i32>,
    pub admin_command: Vec<OsString>,
    pub ipv6_enabled: bool,
    pub setup: bool,
    pub dns: ArgDns,
    pub dns_addr: IpAddr,
    pub bypass: Vec<IpCidr>,
    pub tcp_timeout: u64,
    pub udp_timeout: u64,
    pub verbosity: ArgVerbosity,
}

Fields

proxy: ArgProxy

Proxy URL in the form proto://[username[:password]@]host:port, where proto is one of socks4, socks5, http. Username and password are encoded in percent encoding. For example: socks5://myname:pass%40word@127.0.0.1:1080

tun: Option<String>

Name of the tun interface, such as tun0, utun4, etc. If this option is not provided, the OS will generate a random one.

tun_fd: Option<i32>

File descriptor of the tun interface

close_fd_on_drop: Option<bool>

Set whether to close the received raw file descriptor on drop or not. This setting is passed to the tun2 crate. See tun2::Configuration::close_fd_on_drop.

unshare: bool

Create a tun interface in a newly created unprivileged namespace while maintaining proxy connectivity via the global network namespace.

unshare_pidfile: Option<String>

Create a pidfile of unshare process when using --unshare.

socket_transfer_fd: Option<i32>

File descriptor for UNIX datagram socket meant to transfer network sockets from global namespace to the new one. See unshare(1), namespaces(7), sendmsg(2), unix(7).

admin_command: Vec<OsString>

Specify a command to run with root-like capabilities in the new namespace when using --unshare. This could be useful to start additional daemons, e.g. openvpn instance.

ipv6_enabled: bool

IPv6 enabled

setup: bool

Routing and system setup, which decides whether to setup the routing and system configuration. This option is only available on Linux and requires root-like privileges. See capabilities(7).

dns: ArgDns

DNS handling strategy

dns_addr: IpAddr

DNS resolver address

bypass: Vec<IpCidr>

IPs used in routing setup which should bypass the tunnel, in the form of IP or IP/CIDR. Multiple IPs can be specified, e.g. –bypass 3.4.5.0/24 –bypass 5.6.7.8

tcp_timeout: u64

TCP timeout in seconds

udp_timeout: u64

UDP timeout in seconds

verbosity: ArgVerbosity

Verbosity level

Implementations

impl Args

pub fn parse_args() -> Self

pub fn proxy(&mut self, proxy: ArgProxy) -> &mut Self

pub fn dns(&mut self, dns: ArgDns) -> &mut Self

pub fn tun_fd(&mut self, tun_fd: Option<i32>) -> &mut Self

pub fn close_fd_on_drop(&mut self, close_fd_on_drop: bool) -> &mut Self

pub fn verbosity(&mut self, verbosity: ArgVerbosity) -> &mut Self

pub fn tun(&mut self, tun: String) -> &mut Self

pub fn dns_addr(&mut self, dns_addr: IpAddr) -> &mut Self

pub fn bypass(&mut self, bypass: IpCidr) -> &mut Self

pub fn ipv6_enabled(&mut self, ipv6_enabled: bool) -> &mut Self

pub fn setup(&mut self, setup: bool) -> &mut Self

Trait Implementations

impl Args for Args

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.

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

Append to Command so it can update self.

impl Clone for Args

fn clone(&self) -> Args

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Args

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 Args

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

Formats the value using the given formatter.

impl Default for Args

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Args

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 Args

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.