Struct litep2p::Litep2p

source ·
pub struct Litep2p { /* private fields */ }
Expand description

Litep2p object.

Implementations§

source§

impl Litep2p

source

pub fn new(litep2p_config: Litep2pConfig) -> Result<Litep2p>

Create new Litep2p.

source

pub fn local_peer_id(&self) -> &PeerId

Get local peer ID.

source

pub fn public_addresses(&self) -> PublicAddresses

Get the list of public addresses of the node.

source

pub fn listen_addresses(&self) -> impl Iterator<Item = &Multiaddr>

Get the list of listen addresses of the node.

source

pub fn bandwidth_sink(&self) -> BandwidthSink

Get handle to bandwidth sink.

source

pub async fn dial(&mut self, peer: &PeerId) -> Result<()>

Dial peer.

source

pub async fn dial_address(&mut self, address: Multiaddr) -> Result<()>

Dial address.

source

pub fn add_known_address( &mut self, peer: PeerId, address: impl Iterator<Item = Multiaddr>, ) -> usize

Add one ore more known addresses for peer.

Return value denotes how many addresses were added for the peer. Addresses belonging to disabled/unsupported transports will be ignored.

source

pub async fn next_event(&mut self) -> Option<Litep2pEvent>

Poll next event.

This function must be called in order for litep2p to make progress.

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

§

type Output = T

Should always be Self
source§

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

§

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

§

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