Struct shadowsocks_service::config::Config

source · [−]

pub struct Config {Show 24 fields
    pub server: Vec<ServerConfig>,
    pub local: Vec<LocalConfig>,
    pub dns: DnsConfig,
    pub ipv6_first: bool,
    pub ipv6_only: bool,
    pub no_delay: bool,
    pub fast_open: bool,
    pub keep_alive: Option<Duration>,
    pub nofile: Option<u64>,
    pub outbound_fwmark: Option<u32>,
    pub outbound_bind_interface: Option<String>,
    pub outbound_bind_addr: Option<IpAddr>,
    pub inbound_send_buffer_size: Option<u32>,
    pub inbound_recv_buffer_size: Option<u32>,
    pub outbound_send_buffer_size: Option<u32>,
    pub outbound_recv_buffer_size: Option<u32>,
    pub manager: Option<ManagerConfig>,
    pub config_type: ConfigType,
    pub udp_timeout: Option<Duration>,
    pub udp_max_associations: Option<usize>,
    pub acl: Option<AccessControl>,
    pub security: SecurityConfig,
    pub balancer: BalancerConfig,
    pub config_path: Option<PathBuf>,
}

Expand description

Configuration

Fields

server: Vec<ServerConfig>

Remote ShadowSocks server configurations

local: Vec<LocalConfig>

Local server configuration

dns: DnsConfig

DNS configuration, uses system-wide DNS configuration by default

Value could be a IpAddr, uses UDP DNS protocol with port 53. For example: 8.8.8.8

Also Value could be some pre-defined DNS server names:

google
cloudflare, cloudflare_tls, cloudflare_https
quad9, quad9_tls

ipv6_first: bool

Uses IPv6 addresses first

Set to true if you want to query IPv6 addresses before IPv4

ipv6_only: bool

Set IPV6_V6ONLY for listener sockets

no_delay: bool

Set TCP_NODELAY socket option

fast_open: bool

Set TCP_FASTOPEN socket option

keep_alive: Option<Duration>

Set TCP Keep-Alive duration, will set both TCP_KEEPIDLE and TCP_KEEPINTVL

https://github.com/shadowsocks/shadowsocks-rust/issues/546

If this is not set, sockets will be set with a default timeout

nofile: Option<u64>

RLIMIT_NOFILE option for *nix systems

outbound_fwmark: Option<u32>

Set SO_MARK socket option for outbound sockets

outbound_bind_interface: Option<String>

Set SO_BINDTODEVICE (Linux), IP_BOUND_IF (BSD), IP_UNICAST_IF (Windows) socket option for outbound sockets

outbound_bind_addr: Option<IpAddr>

Outbound sockets will bind to this address

inbound_send_buffer_size: Option<u32>

Set SO_SNDBUF for inbound sockets

inbound_recv_buffer_size: Option<u32>

Set SO_RCVBUF for inbound sockets

outbound_send_buffer_size: Option<u32>

Set SO_SNDBUF for outbound sockets

outbound_recv_buffer_size: Option<u32>

Set SO_RCVBUF for outbound sockets

manager: Option<ManagerConfig>

Manager’s configuration

config_type: ConfigType

Config is for Client or Server

udp_timeout: Option<Duration>

Timeout for UDP Associations, default is 5 minutes

udp_max_associations: Option<usize>

Maximum number of UDP Associations, default is unconfigured

acl: Option<AccessControl>

ACL configuration

security: SecurityConfig

Replay attack policy

balancer: BalancerConfig

Balancer config of local server

config_path: Option<PathBuf>

Configuration file path, the actual path of the configuration. This is normally for auto-reloading if implementation supports.

Implementations

source

impl Config

source

pub fn new(config_type: ConfigType) -> Config

Creates an empty configuration

source

pub fn set_dns_formatted(&mut self, dns: &str) -> Result<(), Error>

Set DNS configuration in string format

[(unix|tcp|udp)://]host[:port][,host[:port]]...
Pre-defined. Like google, cloudflare

source

pub fn load_from_str(s: &str, config_type: ConfigType) -> Result<Config, Error>

Load Config from a str

source

pub fn load_from_file<P: AsRef<Path>>(
filename: P,
config_type: ConfigType
) -> Result<Config, Error>

Load Config from a File

source

pub fn has_server_plugins(&self) -> bool

Check if there are any plugin are enabled with servers

source

pub fn check_integrity(&self) -> Result<(), Error>

Check if all required fields are already set

Trait Implementations

source

impl Clone for Config

source

fn clone(&self) -> Config

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Config

source

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

Formats the value using the given formatter. Read more

source

impl Display for Config

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl !UnwindSafe for Config

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct shadowsocks_service::config::Config

Fields

Implementations

impl Config

pub fn new(config_type: ConfigType) -> Config

pub fn set_dns_formatted(&mut self, dns: &str) -> Result<(), Error>

pub fn load_from_str(s: &str, config_type: ConfigType) -> Result<Config, Error>

pub fn load_from_file<P: AsRef<Path>>( filename: P, config_type: ConfigType) -> Result<Config, Error>

pub fn has_server_plugins(&self) -> bool

pub fn check_integrity(&self) -> Result<(), Error>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Display for Config

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

Auto Trait Implementations

impl !RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl !UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn load_from_file<P: AsRef<Path>>(
filename: P,
config_type: ConfigType
) -> Result<Config, Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,