Struct libp2p_rs::swarm::Swarm [−][src]
pub struct Swarm { /* fields omitted */ }Contains the state of the network, plus the way it should behave.
Implementations
impl Swarm[src]
pub fn new(key: PublicKey) -> Swarm[src]
Builds a new Swarm.
pub fn with_transport(
self,
transport: Box<dyn Transport<Output = Box<dyn StreamMuxerEx + 'static, Global>> + 'static + Send, Global>
) -> Swarm[src]
self,
transport: Box<dyn Transport<Output = Box<dyn StreamMuxerEx + 'static, Global>> + 'static + Send, Global>
) -> Swarm
Adds transport to Swarm.
pub fn with_protocol<T>(self, p: T) -> Swarm where
T: ProtocolImpl, [src]
T: ProtocolImpl,
Adds a protocol into Swarm.
A protocl must implement ProtocolImpl trait. See [Swarm::ProtocolImpl].
pub fn with_ping(self, ping: PingConfig) -> Swarm[src]
Modifies Swarm with Ping service.
pub fn with_routing(self, routing: Box<dyn Routing + 'static, Global>) -> Swarm[src]
Modifies Swarm with routing service.
pub fn with_metric(self, metric: Metric) -> Swarm[src]
Modifies Swarm with Metrics.
pub fn with_identify(self, config: IdentifyConfig) -> Swarm[src]
Modifies Swarm with Identify service.
pub fn control(&self) -> Control[src]
Get an API controller for Swarm.
pub fn start(self)[src]
Starts Swarm background runtime handling the internal events and external controls
pub fn listen_on(
&mut self,
addrs: Vec<Multiaddr, Global>
) -> Result<(), SwarmError>[src]
&mut self,
addrs: Vec<Multiaddr, Global>
) -> Result<(), SwarmError>
Starts listening on the given address.
Returns an error if the address is not supported.
pub fn local_pubkey(&self) -> &PublicKey[src]
Returns the peer ID of the swarm passed as parameter.
pub fn local_peer_id(&self) -> &PeerId[src]
Returns the peer ID of the swarm passed as parameter.
pub fn ban_peer_id(&mut self, peer_id: PeerId)[src]
Bans a peer by its peer ID.
Any incoming connection and any dialing attempt will immediately be rejected. This function has no effect is the peer is already banned.
pub fn unban_peer_id(&mut self, peer_id: PeerId)[src]
Unbans a peer.
Auto Trait Implementations
impl !RefUnwindSafe for Swarm
impl Send for Swarm
impl !Sync for Swarm
impl Unpin for Swarm
impl !UnwindSafe for Swarm
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,