Struct crust::Config

pub struct Config {
    pub hard_coded_contacts: Vec<SocketAddr>,
    pub tcp_acceptor_port: Option<u16>,
    pub force_acceptor_port_in_ext_ep: bool,
    pub service_discovery_port: Option<u16>,
    pub service_discovery_listener_port: Option<u16>,
    pub bootstrap_cache_name: Option<String>,
    pub whitelisted_node_ips: Option<HashSet<IpAddr>>,
    pub whitelisted_client_ips: Option<HashSet<IpAddr>>,
    pub network_name: Option<String>,
    pub dev: Option<DevConfig>,
}

Crust configuration settings

Fields

hard_coded_contacts: Vec<SocketAddr>

Direct contacts one should connect to

tcp_acceptor_port: Option<u16>

Port for TCP acceptor

force_acceptor_port_in_ext_ep: bool

Force usage of tcp_acceptor_port as our router mapped port. Normally if there is a port forwarding, crust will find out what the external world sees our local tcp acceptor endpoint as and include this information in our connection info that we share with others. However there are routers/firewalls in the wild which behave differently when a port is forwarded. They allow inbound connection through the forwarded port, but all outbound connections through the forwarded port get remapped to some ephemeral port. This prevents crust from knowing what the world sees our tcp_acceptor_port as because outbound connections get remapped although the port had been forwarded. In such scenarios, the user can specify this value as true, which will force crust to add the above tcp_acceptor_port to one of our externally reachable endpoint.

service_discovery_port: Option<u16>

Port for service discovery on local network. This port is used to broadcast messages to.

service_discovery_listener_port: Option<u16>

You can configure service discovery server to listen on a separate port. This becomes useful when you want to run multiple instances of Crust on the same machine. By default it will use the same as service_discovery_port value.

bootstrap_cache_name: Option<String>

File for bootstrap cache

whitelisted_node_ips: Option<HashSet<IpAddr>>

Whitelisted nodes who are allowed to bootstrap off us or to connect to us

whitelisted_client_ips: Option<HashSet<IpAddr>>

Whitelisted clients who are allowed to bootstrap off us

network_name: Option<String>

Network ID

This is a mechanism to prevent nodes from different decentralized networks to connect to each other (issue #209)

dev: Option<DevConfig>

Optional developer configuration

Trait Implementations

impl Eq for Config

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl Debug for Config

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

Formats the value using the given formatter.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.