Struct shadowsocks::config::ServerConfig

pub struct ServerConfig { /* private fields */ }

Configuration for a server

Implementations

impl ServerConfig

pub fn new<A, P>(addr: A, password: P, method: CipherKind) -> ServerConfig

where A: Into<ServerAddr>, P: Into<String>,

Create a new ServerConfig

pub fn set_method<P>(&mut self, method: CipherKind, password: P)

where P: Into<String>,

Set encryption method

pub fn set_plugin(&mut self, p: PluginConfig)

Set plugin

pub fn set_addr<A>(&mut self, a: A)

where A: Into<ServerAddr>,

Set server addr

pub fn addr(&self) -> &ServerAddr

Get server address

pub fn key(&self) -> &[u8]

Get encryption key

pub fn password(&self) -> &str

Get password

pub fn identity_keys(&self) -> &[Bytes]

Get identity keys (Client)

pub fn clone_identity_keys(&self) -> Arc<Vec<Bytes>>

Clone identity keys (Client)

pub fn set_user_manager(&mut self, user_manager: ServerUserManager)

Set user manager, enable Server’s multi-user support with EIH

pub fn user_manager(&self) -> Option<&ServerUserManager>

Get user manager (Server)

pub fn clone_user_manager(&self) -> Option<Arc<ServerUserManager>>

Clone user manager (Server)

pub fn method(&self) -> CipherKind

Get method

pub fn plugin(&self) -> Option<&PluginConfig>

Get plugin

pub fn set_plugin_addr(&mut self, a: ServerAddr)

Set plugin address

pub fn plugin_addr(&self) -> Option<&ServerAddr>

Get plugin address

pub fn tcp_external_addr(&self) -> &ServerAddr

Get server’s TCP external address

pub fn udp_external_addr(&self) -> &ServerAddr

Get server’s UDP external address

pub fn set_timeout(&mut self, timeout: Duration)

Set timeout

pub fn timeout(&self) -> Option<Duration>

Timeout

pub fn remarks(&self) -> Option<&str>

Get server’s remark

pub fn set_remarks<S>(&mut self, remarks: S)

where S: Into<String>,

Set server’s remark

pub fn id(&self) -> Option<&str>

Get server’s ID (SIP008)

pub fn set_id<S>(&mut self, id: S)

where S: Into<String>,

Set server’s ID (SIP008)

pub fn mode(&self) -> Mode

Get server’s Mode

pub fn set_mode(&mut self, mode: Mode)

Set server’s Mode

pub fn weight(&self) -> &ServerWeight

Get server’s balancer weight

pub fn set_weight(&mut self, weight: ServerWeight)

Set server’s balancer weight

pub fn to_qrcode_url(&self) -> String

Get URL for QRCode

ss:// + base64(method:password@host:port)

pub fn to_url(&self) -> String

Get SIP002 URL

pub fn from_url(encoded: &str) -> Result<ServerConfig, UrlParseError>

Parse from SIP002 URL

Extended formats:

1. QRCode URL supported by shadowsocks-android, https://github.com/shadowsocks/shadowsocks-android/issues/51
2. Plain userinfo:password format supported by go2-shadowsocks2

pub fn is_basic(&self) -> bool

Check if it is a basic format server

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl FromStr for ServerConfig

type Err = UrlParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ServerConfig, Self::Err>

Parses a string s to return a value of this type.