Struct Config

pub struct Config {

    pub privacy_level: isize,
    pub location: Option<String>,
    pub roles: HashSet<Role>,
    pub entry_peers: Vec<Multiaddr>,
    pub keypair: Keypair,
    pub listen_on: Vec<Multiaddr>,
    pub namespace: String,
    pub discovery_ttl: Option<u64>,
    pub static_exits: Vec<Multiaddr>,
    pub static_routes: Vec<RouteDescriptor>,
    pub sserver_listen_addr: String,
    pub sclient_listen_addr: String,
    pub fdlimit: bool,
    pub external_addrs: Vec<Multiaddr>,
    pub outbound_addrs: Vec<Multiaddr>,
    pub is_fly_io: bool,
    pub protect_socket_fn: Option<ProtectSocketFn>,
    pub token: Option<String>,
    pub device_id: Option<String>,
    pub route_auth_enabled: bool,
}

Fields

privacy_level: isize

Peer privacy level

The lower the level, the more privacy is granted

This parameter affects geohash precision and internal behaviour

From 0 to 12 If 0 is provided no location will be set

location: Option<String>

Peer geohashed location

roles: HashSet<Role>

Peer behaviour roles

entry_peers: Vec<Multiaddr>

First HOP peer multiaddresses

keypair: Keypair

Peer identity keypair

listen_on: Vec<Multiaddr>

namespace: String

Discovery namespace

discovery_ttl: Option<u64>

Discovery TTL in seconds

static_exits: Vec<Multiaddr>

Static Exits deprecated

static_routes: Vec<RouteDescriptor>

Static routes

sserver_listen_addr: String

Socks Listen Address

sclient_listen_addr: String

Socks Client Listen Address

fdlimit: bool

modify fdlimit

external_addrs: Vec<Multiaddr>

External addresses

outbound_addrs: Vec<Multiaddr>

Outbound addresses

is_fly_io: bool

Fly.io mode.

protect_socket_fn: Option<ProtectSocketFn>

token: Option<String>

device_id: Option<String>

route_auth_enabled: bool

Implementations

impl Config

pub fn has_entry(&self, id: &PeerId) -> bool

pub fn has_static_exit(&self, id: &PeerId) -> bool

pub fn with_role(&mut self, role: Role)

pub fn with_privacy_level(self, privacy_level: isize) -> Result<Self, Error>

pub fn with_location(self, location: String) -> Self

pub fn with_coordinates(self, coord: Coord) -> Result<Self, GeohashError>

pub fn with_first_hops(self, first_hops: Vec<Multiaddr>) -> Self

pub fn with_first_hop(self, first_hop: Multiaddr) -> Self

pub fn with_roles(self, roles: HashSet<Role>) -> Self

pub fn with_keypair(self, keypair: Keypair) -> Self

pub fn with_sserver_listen_addr(self, listen_addr: String) -> Self

pub fn with_sclient_listen_addr(self, listen_addr: String) -> Self

pub fn with_external_addrs(self, external_addrs: Vec<Multiaddr>) -> Self

pub fn with_outbound_addrs(self, outbound_addrs: Vec<Multiaddr>) -> Self

pub fn with_fly_io(self, is_fly_io: bool) -> Self

pub fn with_protect_socket_fn( self, protect_socket_fn: Arc<dyn Fn(i32) + Send + Sync>, ) -> Self

pub fn with_token(self, token: String) -> Self

pub fn with_route_auth_enabled(self, route_auth_enabled: bool) -> Self

pub fn seal(self) -> Result<Vec<u8>, Error>

pub fn unseal(data: Vec<u8>) -> Result<Self, Error>

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

fn default() -> Self

Returns the “default value” for a type.

impl From<&Config> for Identity

fn from(config: &Config) -> Self

Converts to this type from the input type.

impl From<&Config> for SnowstormBehaviour

fn from(config: &Config) -> SnowstormBehaviour

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(_config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(_config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Toggle<Behaviour>

fn from(config: &Config) -> Toggle<Behaviour>

Converts to this type from the input type.

impl From<&Config> for Vec<Namespace>

fn from(config: &Config) -> Self

Converts to this type from the input type.

impl From<Config> for SerializableConfig

fn from(config: Config) -> Self

Converts to this type from the input type.

impl From<SerializableConfig> for Config

fn from(config: SerializableConfig) -> Self

Converts to this type from the input type.