Enum Role

pub enum Role {
    Client = 0,
    Server = 1,
}

Roles in the QUIC protocol, including client and server.

The least significant bit (0x01) of the StreamId identifies the initiator role of the stream. Client-initiated streams have even-numbered stream IDs (with the bit set to 0), and server-initiated streams have odd-numbered stream IDs (with the bit set to 1). See section-2.1-3 of QUIC.

Note

As a protocol capable of multiplexing streams, QUIC is different from traditional HTTP protocols for clients and servers. In the QUIC protocol, it is not only the client that can actively open a new stream; the server can also actively open a new stream to push some data to the client. In fact, in a new stream, the server can initiate an HTTP3 request to the client, and the client, upon receiving the request, responds back to the server. In this case, the client surprisingly plays the role of the traditional “server”, which is quite fascinating.

Example

use qbase::role::Role;

let local = Role::Client;
let peer = !local;
let is_client = matches!(local, Role::Client); // true
let is_server = matches!(peer, Role::Server); // true

Variants

Client = 0

The initiator of a connection

Server = 1

The acceptor of a connection

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl Display for Role

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

Formats the value using the given formatter.

impl From<Client> for Role

fn from(_: Client) -> Role

Converts to this type from the input type.

impl From<Server> for Role

fn from(_: Server) -> Role

Converts to this type from the input type.

impl Hash for Role

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for Role

type Output = Role

The resulting type after applying the ! operator.

fn not(self) -> Role

Performs the unary ! operation.

impl Ord for Role

fn cmp(&self, other: &Role) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Role

fn eq(&self, other: &Role) -> 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 PartialOrd for Role

fn partial_cmp(&self, other: &Role) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Role

impl Eq for Role

impl StructuralPartialEq for Role