Struct libp2p_swarm::dial_opts::DialOpts

pub struct DialOpts(_);

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

impl DialOpts

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();

pub fn unknown_peer_id() -> WithoutPeerId

Dial an unknown peer.

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

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

Get the PeerId specified in a DialOpts if any.

Trait Implementations

impl Debug for DialOpts

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

Formats the value using the given formatter.

impl From<Multiaddr> for DialOpts

fn from(address: Multiaddr) -> Self

Converts to this type from the input type.

impl From<PeerId> for DialOpts

fn from(peer_id: PeerId) -> Self

Converts to this type from the input type.