Struct Request 

pub struct Request { /* private fields */ }

A connection request by the remote endpoint.

Dropping the request rejects it.

Implementations

impl Request

pub fn remote_port(&self) -> u32

The remote port number.

pub fn id(&self) -> u32

The remotely provided id.

If no id was provided, this returns the remote port.

pub fn is_wait(&self) -> bool

Indicates whether the handler of the request should wait for a local port to become available, if all are currently in use.

pub fn is_pre_connected(&self) -> bool

Returns whether the remote endpoint provisionally opened this channel.

A pre-connected channel may already carry data even though this request has not yet been accepted. Rejecting the request also rejects that provisional channel.

pub async fn accept_tentatively( self, ) -> Result<(Sender, Receiver, AcceptGuard), TentativeAcceptError>

Tentatively accepts the request, so that it can still be rejected afterwards.

This consumes the request and returns the sender and receiver for the new bidirectional port together with a guard that allows rejecting the connection afterwards. Dropping the guard confirms the connection.

Use this when the decision whether to serve the channel depends on a result that is not available yet, for example the response of another endpoint the channel is forwarded to. Data can be exchanged over the port while the decision is pending.

This is only possible for a pre-connected request, since only its requester is prepared to be told about a rejection after the channel has been established. Otherwise TentativeAcceptError::NotPreConnected is returned and the request is rejected.

pub async fn accept(self) -> Result<(Sender, Receiver), ListenerError>

Accepts the request.

This consumes the request and returns the sender and receiver for the new bidirectional port. It may wait for a local port number when the requester permits waiting.

pub async fn reject(self, no_ports: bool)

Rejects the connect request.

Setting no_ports to true indicates to the remote endpoint that the request was rejected because no local port could be allocated.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl Drop for Request

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.