ConfigBuilder

Struct ConfigBuilder 

Source
pub struct ConfigBuilder { /* private fields */ }
Expand description

A builder for building a configuration set for a Koibumi Bitmessage node.

Implementations§

Source§

impl Builder

Source

pub fn core(&mut self, core: CoreConfig) -> &mut Self

Sets the core configuration set which the configuration set this builder builds contains. The default is the default of the core configuration set.

Source

pub fn channel_buffer(&mut self, v: usize) -> &mut Self

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

Source

pub fn server(&mut self, addr: Option<StdSocketAddr>) -> &mut Self

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

Source

pub fn socks(&mut self, addr: Option<StdSocketAddr>) -> &mut Self

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

Source

pub fn socks_auth(&mut self, auth: Option<SocksAuth>) -> &mut Self

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

Source

pub fn connect_to_onion(&mut self, b: bool) -> &mut Self

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

Source

pub fn connect_to_ip(&mut self, b: bool) -> &mut Self

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

Source

pub fn connect_to_myself(&mut self, b: bool) -> &mut Self

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

Source

pub fn user_agent(&mut self, s: UserAgent) -> &mut Self

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

Source

pub fn stream_numbers(&mut self, list: StreamNumbers) -> &mut Self

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

Source

pub fn seeds(&mut self, list: Vec<SocketAddrExt>) -> &mut Self

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

Source

pub fn bootstraps(&mut self, list: Vec<SocketAddrNode>) -> &mut Self

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

Source

pub fn max_incoming_connected(&mut self, n: usize) -> &mut Self

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

Source

pub fn max_incoming_established(&mut self, n: usize) -> &mut Self

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

Source

pub fn max_outgoing_initiated(&mut self, n: usize) -> &mut Self

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

Source

pub fn max_outgoing_established(&mut self, n: usize) -> &mut Self

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

Source

pub fn max_nodes(&mut self, n: usize) -> &mut Self

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

Source

pub fn own_nodes(&mut self, list: Vec<SocketAddrExt>) -> &mut Self

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

Source

pub fn build(&self) -> Config

Returns the configuration set this builder represents.

Trait Implementations§

Source§

impl Clone for Builder

Source§

fn clone(&self) -> Builder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Builder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Builder

Source§

fn default() -> Builder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Builder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Builder

Source§

impl StructuralPartialEq for Builder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more