Struct Request

#[non_exhaustive]
pub struct Request {
    pub id: String,
    pub method: String,
    pub headers: HashMap<String, String>,
    pub path: String,
    pub host: String,
    pub scheme: String,
    pub query: String,
    pub time: Option<Timestamp>,
    pub size: i64,
    pub protocol: String,
    pub reason: String,
    pub auth: Option<Auth>,
    /* private fields */
}

This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

method: String

The HTTP request method, such as GET, POST.

headers: HashMap<String, String>

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

path: String

The HTTP URL path, excluding the query parameters.

host: String

The HTTP request Host header value.

scheme: String

The HTTP URL scheme, such as http and https.

query: String

The HTTP URL query in the format of name1=value1&name2=value2, as it appears in the first line of the HTTP request. No decoding is performed.

time: Option<Timestamp>

The timestamp when the destination service receives the last byte of the request.

size: i64

The HTTP request size in bytes. If unknown, it must be -1.

protocol: String

The network protocol used with the request, such as “http/1.1”, “spdy/3”, “h2”, “h2c”, “webrtc”, “tcp”, “udp”, “quic”. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

reason: String

A special parameter for request reason. It is used by security systems to associate auditing information with a request.

auth: Option<Auth>

The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request Authorization header or equivalent.

Implementations

impl Request

pub fn new() -> Self

pub fn set_id<T: Into<String>>(self, v: T) -> Self

Sets the value of id.

pub fn set_method<T: Into<String>>(self, v: T) -> Self

Sets the value of method.

pub fn set_headers<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of headers.

pub fn set_path<T: Into<String>>(self, v: T) -> Self

Sets the value of path.

pub fn set_host<T: Into<String>>(self, v: T) -> Self

Sets the value of host.

pub fn set_scheme<T: Into<String>>(self, v: T) -> Self

Sets the value of scheme.

pub fn set_query<T: Into<String>>(self, v: T) -> Self

Sets the value of query.

pub fn set_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of time.

pub fn set_or_clear_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of time.

pub fn set_size<T: Into<i64>>(self, v: T) -> Self

Sets the value of size.

pub fn set_protocol<T: Into<String>>(self, v: T) -> Self

Sets the value of protocol.

pub fn set_reason<T: Into<String>>(self, v: T) -> Self

Sets the value of reason.

pub fn set_auth<T>(self, v: T) -> Self

where T: Into<Auth>,

Sets the value of auth.

pub fn set_or_clear_auth<T>(self, v: Option<T>) -> Self

where T: Into<Auth>,

Sets or clears the value of auth.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl Message for Request

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Request

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