Struct koibumi_node_sync::Config

pub struct Config { /* fields omitted */ }

A set of configurations for a Koibumi Bitmessage node.

Implementations

impl Config

pub fn builder() -> Builder

Constructs a builder for building a configuration set.

pub fn new() -> Self

Constructs a default configuration set.

pub fn core(&self) -> &CoreConfig

Returns the core configuration set which this configuration set contains. The default is the default of the core configuration set.

pub fn channel_buffer(&self) -> usize

Returns the buffer size of channels which will be created in this node. The default is 0x10000.

pub fn server(&self) -> &Option<StdSocketAddr>

Returns the Option of the socket address of the server which listens incomming connections. If this is None, no server will be launched. The default is None.

pub fn socks(&self) -> &Option<StdSocketAddr>

Returns the Option of the socket address of the SOCKS5 server which is used by outgoing connections. If this is None, connections are directly to Clearnet. The default is None.

pub fn socks_auth(&self) -> &Option<SocksAuth>

Returns the Option of the authentication method of the SOCKS5 which is used by outgoing connections. The default is None.

pub fn connect_to_onion(&self) -> bool

Returns the flag whether this node connects to remote nodes that have Onion addresses. Only outgoing connections are affected. The default is false.

pub fn connect_to_ip(&self) -> bool

Returns the flag whether this node connects to remote nodes that have IP addresses. Only outgoing connections are affected. The default is false.

pub fn is_connectable_to(&self, addr: &SocketAddrNode) -> bool

Returns whether this node can connect to the node specified by the socket address. It is affected by the type of the address which is Onion or IP.

pub fn connect_to_myself(&self) -> bool

Returns the flag whether this node can connect to this node itself. The default is false.

pub fn user_agent(&self) -> &UserAgent

Returns the user agent which is sent to the nodes this node connected to. The default is "/PyBitmessage:0.6.3.2/".

pub fn stream_numbers(&self) -> &StreamNumbers

Returns the set of stream numbers that this node is interested in. The default is [1].

pub fn seeds(&self) -> &[SocketAddrExt]

Returns the list of socket addresses of the seed nodes. The default is [].

pub fn bootstraps(&self) -> &[SocketAddrNode]

Returns the list of socket addresses of the bootstrap domain names. The default is [].

pub fn max_incoming_connected(&self) -> usize

Returns the maximum number of incoming connections this node accepts. The default is 160.

pub fn max_incoming_established(&self) -> usize

Returns the maximum number of incoming established connections this node accepts. The default is 128.

pub fn max_outgoing_initiated(&self) -> usize

Returns the maximum number of outgoing conections this node initiates. The default is 32.

pub fn max_outgoing_established(&self) -> usize

Returns the maximum number of outgoing established connections this node keeps. The default is 8.

pub fn max_nodes(&self) -> usize

Returns the maximum number of node addresses this node memorizes. The default is 20000.

pub fn own_nodes(&self) -> &[SocketAddrExt]

Returns the list of the socket addresses of the own node. The default is [].

Trait Implementations

impl Clone for Config

pub 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

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

Formats the value using the given formatter.

impl Default for Config

pub fn default() -> Self

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq<Config> for Config

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

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

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

This method tests for !=.

impl Serialize for Config

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Config

impl StructuralPartialEq for Config