Struct Session 

pub struct Session { /* private fields */ }

A session represents a client-to-server connection.

This is the main entry point for creating streams and sending datagrams. Either endpoint may close the session with an error code and reason.

The session can be cloned to create multiple handles. However, handles cannot currently accept or open the same stream type.

Implementations

impl Session

pub fn new(inner: WebTransport, url: Url) -> Self

pub async fn accept_uni(&self) -> Result<RecvStream, Error>

Accept a new unidirectional stream from the peer.

pub async fn accept_bi(&self) -> Result<(SendStream, RecvStream), Error>

Accept a new bidirectional stream from the peer.

pub async fn open_bi(&self) -> Result<(SendStream, RecvStream), Error>

Create a new bidirectional stream.

pub async fn open_uni(&self) -> Result<SendStream, Error>

Create a new unidirectional stream.

pub async fn send_datagram(&self, payload: Bytes) -> Result<(), Error>

Send a datagram over the network.

pub async fn recv_datagram(&self) -> Result<Bytes, Error>

Receive a datagram over the network.

pub fn close(&self, code: u32, reason: &str)

Close the session with the given error code and reason.

pub async fn closed(&self) -> Error

Block until the session closes and return the error.

pub fn url(&self) -> &Url

Return the URL used to create the session.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for Session

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Session for Session

Available on target_family=wasm only.

type SendStream = SendStream

Outgoing stream type returned by open_* and accept_bi.

type RecvStream = RecvStream

Incoming stream type returned by accept_* and open_bi.

type Error = Error

Error type returned by session operations.

async fn accept_uni(&self) -> Result<Self::RecvStream, Self::Error>

Block until the peer creates a new unidirectional stream.

async fn accept_bi( &self, ) -> Result<(Self::SendStream, Self::RecvStream), Self::Error>

Block until the peer creates a new bidirectional stream.

async fn open_bi( &self, ) -> Result<(Self::SendStream, Self::RecvStream), Self::Error>

Open a new bidirectional stream, which may block if too many streams are open.

async fn open_uni(&self) -> Result<Self::SendStream, Self::Error>

Open a new unidirectional stream, which may block if too many streams are open.

fn send_datagram(&self, payload: Bytes) -> Result<(), Self::Error>

Send a datagram over the network.

async fn recv_datagram(&self) -> Result<Bytes, Self::Error>

Receive a datagram over the network.

fn max_datagram_size(&self) -> usize

Return the maximum size of a datagram that can be sent.

fn close(&self, code: u32, reason: &str)

Close the connection immediately with a code and reason.

async fn closed(&self) -> Self::Error

Block until the connection is closed by either side.

impl Eq for Session