Struct libp2p::swarm::dial_opts::DialOpts

source · [−]

pub struct DialOpts(_);

Expand description

Options to configure a dial to a known or unknown peer.

Used in Swarm::dial and NetworkBehaviourAction::Dial.

To construct use either of:

DialOpts::peer_id dialing a known peer
DialOpts::unknown_peer_id dialing an unknown peer

Implementations

source

impl DialOpts

source

pub fn peer_id(peer_id: PeerId) -> WithPeerId

Dial a known peer.

DialOpts::peer_id(PeerId::random())
   .condition(PeerCondition::Disconnected)
   .addresses(vec!["/ip6/::1/tcp/12345".parse().unwrap()])
   .extend_addresses_through_behaviour()
   .build();

source

pub fn unknown_peer_id() -> WithoutPeerId

Dial an unknown peer.

DialOpts::unknown_peer_id()
   .address("/ip6/::1/tcp/12345".parse().unwrap())
   .build();

source

pub fn get_peer_id(&self) -> Option<PeerId>

Get the PeerId specified in a DialOpts if any.

Trait Implementations

source

impl Debug for DialOpts

source

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

Formats the value using the given formatter. Read more

source

impl From<Multiaddr> for DialOpts

source

pub fn from(address: Multiaddr) -> DialOpts

Performs the conversion.

source

impl From<PeerId> for DialOpts

source

pub fn from(peer_id: PeerId) -> DialOpts

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for DialOpts

impl Send for DialOpts

impl Sync for DialOpts

impl Unpin for DialOpts

impl UnwindSafe for DialOpts

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

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

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct libp2p::swarm::dial_opts::DialOpts

Implementations

impl DialOpts

pub fn peer_id(peer_id: PeerId) -> WithPeerId

pub fn unknown_peer_id() -> WithoutPeerId

pub fn get_peer_id(&self) -> Option<PeerId>

Trait Implementations

impl Debug for DialOpts

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

impl From<Multiaddr> for DialOpts

pub fn from(address: Multiaddr) -> DialOpts

impl From<PeerId> for DialOpts

pub fn from(peer_id: PeerId) -> DialOpts

Auto Trait Implementations

impl RefUnwindSafe for DialOpts

impl Send for DialOpts

impl Sync for DialOpts

impl Unpin for DialOpts

impl UnwindSafe for DialOpts

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<T> Erased for T

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

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

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

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

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

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

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