Struct Config 

pub struct Config {

    pub server: Vec<ServerInstanceConfig>,
    pub local: Vec<LocalInstanceConfig>,
    pub dns: DnsConfig,
    pub dns_cache_size: Option<usize>,
    pub ipv6_first: bool,
    pub ipv6_only: bool,
    pub no_delay: bool,
    pub fast_open: bool,
    pub keep_alive: Option<Duration>,
    pub mptcp: bool,
    pub nofile: Option<u64>,
    pub outbound_fwmark: Option<u32>,
    pub outbound_bind_interface: Option<String>,
    pub outbound_bind_addr: Option<IpAddr>,
    pub outbound_udp_allow_fragmentation: bool,
    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 udp_mtu: Option<usize>,
    pub acl: Option<AccessControl>,
    pub security: SecurityConfig,
    pub balancer: BalancerConfig,
    pub config_path: Option<PathBuf>,
}

Configuration

Fields

server: Vec<ServerInstanceConfig>

Remote ShadowSocks server configurations

local: Vec<LocalInstanceConfig>

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

dns_cache_size: Option<usize>

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

mptcp: bool

Multipath-TCP

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

outbound_udp_allow_fragmentation: bool

Outbound UDP sockets allow IP fragmentation

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

udp_mtu: Option<usize>

Maximum Transmission Unit (MTU) size for UDP packets 65535 by default. Suggestion: 1500 NOTE: mtu includes IP header, UDP header, UDP payload

acl: Option<AccessControl>

ACL configuration (Global)

Could be overwritten by servers/locals’ private acl

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

impl Config

pub fn new(config_type: ConfigType) -> Self

Creates an empty configuration

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

Set DNS configuration in string format

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

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

Load Config from a str

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

Load Config from a JSON str

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

Load Config from a File

pub fn has_server_plugins(&self) -> bool

Check if there are any plugin are enabled with servers

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

Check if all required fields are already set

Trait Implementations

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

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

Formats the value using the given formatter.

impl Display for Config

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

Formats the value using the given formatter.