pub struct DialOpts { /* private fields */ }
Expand description

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

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

To construct use either of:

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>

Retrieves the PeerId from the DialOpts if specified or otherwise tries to extract it from the multihash in the /p2p part of the address, if present.

source

pub fn connection_id(&self) -> ConnectionId

Get the ConnectionId of this dial attempt.

All future events of this dial will be associated with this ID. See DialFailure and ConnectionEstablished.

Trait Implementations§

source§

impl Debug for DialOpts

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Multiaddr> for DialOpts

source§

fn from(address: Multiaddr) -> Self

Converts to this type from the input type.
source§

impl From<PeerId> for DialOpts

source§

fn from(peer_id: PeerId) -> Self

Converts to this type from the input type.

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