Struct TransitConnector

Source

pub struct TransitConnector { /* private fields */ }

Expand description

A partially set up Transit connection.

For the transit handshake, each side generates a Hints with all the information to find the other. You need to exchange it (as in: send yours, receive theirs) with them. This is outside of the transit protocol, because we are protocol agnostic.

Implementations§

Source §

impl TransitConnector

Source

pub fn our_abilities(&self) -> &Abilities

The abilities that we’ve sent to the other side

Source

pub fn our_hints(&self) -> &Arc<Hints>

Send this one to the other side

Source

pub async fn connect( self, role: TransitRole, transit_key: Key<TransitKey>, their_abilities: Abilities, their_hints: Arc<Hints>, ) -> Result<(Transit, TransitInfo), TransitConnectError>

Connect to the other side.

One side must call with role set to TransitRole::Leader and the other with TransitRole::Follower.

Auto Trait Implementations§

§

impl UnwindSafe for TransitConnector

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

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §