swarm_nl::core

Struct CoreBuilder

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

Structure containing necessary data to build Core.

Implementations§

Source§

impl CoreBuilder

Source

pub fn with_config(config: BootstrapConfig) -> Self

Return a CoreBuilder struct configured with BootstrapConfig and default values. Here, it is certain that BootstrapConfig contains valid data.

Source

pub fn with_network_id(self, protocol: String) -> Self

Explicitly configure the network (protocol) id.

Note that it must be of the format “/protocol-name/version” otherwise it will default to “/swarmnl/1.0”. See: DEFAULT_NETWORK_ID.

Source

pub fn listen_on(self, ip_address: IpAddr) -> Self

Configure the IP address to listen on.

If none is specified, the default value is Ipv4Addr::new(0, 0, 0, 0). See: DEFAULT_IP_ADDRESS.

Source

pub fn with_idle_connection_timeout(self, keep_alive_duration: Seconds) -> Self

Configure how long to keep a connection alive (in seconds) once it is idling.

Source

pub fn with_stream_size(self, size: usize) -> Self

Configure the size of the stream buffers to use to track application requests to the network layer internally. This should be as large an possible to prevent dropping off requests to the network layer. Defaults to usize::MAX.

Source

pub fn with_ping(self, config: PingConfig) -> Self

Configure the Ping protocol for the network.

Source

pub fn with_replication(self, repl_cfg: ReplNetworkConfig) -> Self

Configure the Replication protocol for the network.

Source

pub fn with_sharding<T: ShardStorage + 'static>( self, network_id: String, local_shard_storage: Arc<Mutex<T>>, ) -> Self

Configure the Sharding protocol for the network.

Source

pub fn with_rpc( self, config: RpcConfig, handler: fn(RpcData) -> RpcData, ) -> Self

Configure the RPC protocol for the network.

Source

pub fn with_kademlia(self, config: Config) -> Self

Configure the Kademlia protocol for the network.

Source

pub fn with_gossipsub( self, config: GossipsubConfig, filter_fn: fn(PeerId, MessageId, Option<PeerId>, String, Vec<String>) -> bool, ) -> Self

Configure the Gossipsub protocol for the network.

§Panics

This function panics if Gossipsub cannot be configured properly.

Source

pub fn with_transports(self, transport: TransportOpts) -> Self

Configure the transports to support.

Source

pub fn network_id(&self) -> String

Return the id of the network.

Source

pub async fn build(self) -> SwarmNlResult<Core>

Build the Core data structure.

Handles the configuration of the libp2p Swarm structure and the selected transport protocols, behaviours and node identity for tokio and async-std runtimes. The Swarm is wrapped in the Core construct which serves as the interface to interact with the internal networking layer.

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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, 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T