Struct HttpRequest

pub struct HttpRequest {

    pub id: String,
    pub method: String,
    pub headers: HashMap<String, String>,
    pub header_map: Option<HeaderMap>,
    pub path: String,
    pub host: String,
    pub scheme: String,
    pub query: String,
    pub fragment: String,
    pub size: i64,
    pub protocol: String,
    pub body: String,
    pub raw_body: Vec<u8>,
}

This message defines attributes for an HTTP request. HTTP/1.x, HTTP/2, gRPC are all considered as HTTP requests. [#next-free-field: 14]

Fields

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. For HTTP requests, it should be X-Request-ID or equivalent.

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 lower-cased, because HTTP header keys are case-insensitive. Header value is encoded as UTF-8 string. Non-UTF-8 characters will be replaced by “!”. This field will not be set if :ref:encode_raw_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.encode_raw_headers> is set to true.

header_map: Option<HeaderMap>

A list of the raw HTTP request headers. This is used instead of :ref:headers <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.headers> when :ref:encode_raw_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.encode_raw_headers> is set to true.

Note that this is not actually a map type. header_map contains a single repeated field headers.

Here, only the key and raw_value fields will be populated for each HeaderValue, and that is only when :ref:encode_raw_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.encode_raw_headers> is set to true.

Also, unlike the :ref:headers <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.headers> field, headers with the same key are not combined into a single comma separated header.

path: String

The request target, as it appears in the first line of the HTTP request. This includes the URL path and query-string. No decoding is performed.

host: String

The HTTP request Host or :authority header value.

scheme: String

The HTTP URL scheme, such as http and https.

query: String

This field is always empty, and exists for compatibility reasons. The HTTP URL query is included in path field.

fragment: String

This field is always empty, and exists for compatibility reasons. The URL fragment is not submitted as part of HTTP requests; it is unknowable.

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.0”, “HTTP/1.1”, or “HTTP/2”.

See :repo:headers.h:ProtocolStrings <source/common/http/headers.h> for a list of all possible values.

body: String

The HTTP request body.

raw_body: Vec<u8>

The HTTP request body in bytes. This is used instead of :ref:body <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body> when :ref:pack_as_bytes <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.BufferSettings.pack_as_bytes> is set to true.

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequest

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

Formats the value using the given formatter.

impl Default for HttpRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for HttpRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for HttpRequest

const NAME: &'static str = "HttpRequest"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.service.auth.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for HttpRequest

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