Struct ClientRequest 

pub struct ClientRequest { /* private fields */ }

Available on crate feature server only.

Details about an incoming relay client connection.

Passed to AccessControl::on_connect to decide whether to admit the connection.

Implementations

impl ClientRequest

pub fn new( endpoint_id: EndpointId, protocol_version: ProtocolVersion, request: Parts, ) -> Self

Creates a new ClientRequest from an EndpointId and HTTP request parts.

The EndpointId must be proven by the relay handshake. The request parts come from the client’s WebSocket request. A fresh ConnectionId is assigned.

pub fn connection_id(&self) -> ConnectionId

Returns the ConnectionId assigned to this connection.

pub fn protocol_version(&self) -> ProtocolVersion

Returns the ProtocolVersion negotiated for this connection.

pub fn endpoint_id(&self) -> EndpointId

Returns the EndpointId of the client.

The relay handshake authenticates this id before the access hook is invoked. The client proves possession of the secret key for this public key by either signing keying material exported from the TLS session or a challenge issued by the server.

pub fn uri(&self) -> &Uri

Returns the URI of the HTTP request with which the client connected.

pub fn query_pairs(&self) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Returns an iterator over the query parameters set in the URI of the HTTP request.

Each item is a (name, value) pair. Both names and values are percent-decoded. The query string is parsed in order, and the same name may appear more than once.

pub fn headers(&self) -> &HeaderMap

Returns the headers of the HTTP request with which the client connected.

pub fn auth_token(&self) -> Option<String>

Returns the authorization token from the client’s HTTP request, if any.

Walks the Authorization headers in order and returns the value of the first one whose scheme is Bearer (matched case-insensitively). Headers with a different scheme are skipped.

If none of the Authorization headers carries a Bearer scheme, returns the value of the token URL query parameter, or None if the URL has no token parameter.

If an Authorization header value is not valid UTF-8 the function returns None immediately, without checking later headers or the URL query.

Trait Implementations

impl Clone for ClientRequest

fn clone(&self) -> ClientRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientRequest

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

Formats the value using the given formatter.