Struct magic_wormhole::forwarding::ConnectOffer

source · [−]

pub struct ConnectOffer {
    pub mapping: Vec<(u16, Rc<String>)>,
    /* private fields */
}

Expand description

A pending forwarding offer from the other side

You should consume this object, either by calling accept or reject.

Fields

mapping: Vec<(u16, Rc<String>)>

Implementations

impl ConnectOffer

pub async fn accept(
self,
cancel: impl Future<Output = ()>
) -> Result<(), ForwardingError>

Accept the offer and start the forwarding

The method will run until an error occurs, the peer terminates the connection or cancel resolves. The last one can be used to provide timeouts or to inject CTRL-C handling. If you want the forward to never (successfully) stop, pass [futures::future::pending()] as the value.

pub async fn reject(self) -> Result<(), ForwardingError>

Reject the offer

This will send an error message to the other side so that it knows the transfer failed.

Auto Trait Implementations

impl RefUnwindSafe for ConnectOffer

impl !Send for ConnectOffer

impl !Sync for ConnectOffer

impl Unpin for ConnectOffer

impl UnwindSafe for ConnectOffer

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V