Struct shadowsocks_service::config::Config

pub struct Config {
    pub server: Vec<ServerConfig>,
    pub local_addr: Option<IpAddr>,
    pub local: Vec<LocalConfig>,
    pub dns: DnsConfig,
    pub ipv6_first: bool,
    pub no_delay: bool,
    pub nofile: Option<u64>,
    pub outbound_fwmark: Option<u32>,
    pub outbound_bind_interface: Option<OsString>,
    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>,
}

Configuration

Fields

server: Vec<ServerConfig>

Remote ShadowSocks server configurations

local_addr: Option<IpAddr>

Local server’s bind address, or ShadowSocks server’s outbound address

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

no_delay: bool

Set TCP_NODELAY socket option

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<OsString>

Set SO_BINDTODEVICE socket option for outbound sockets

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

Implementations

impl Config

pub fn new(config_type: ConfigType) -> Config

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<Config, Error>

Load Config from a str

pub fn load_from_file(
    filename: &str,
    config_type: ConfigType
) -> Result<Config, 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 copy of the value.

pub 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.