Struct envoy_sdk::host::HeaderMap

pub struct HeaderMap { /* fields omitted */ }

Implementations

impl HeaderMap

pub fn builder() -> HeaderMapBuilder

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn as_slice(&self) -> &[(ByteString, ByteString)]

pub fn into_vec(self) -> Vec<(ByteString, ByteString)>

pub fn iter(&self) -> Iter<'_>

pub fn get<Q>(&self, key: Q) -> Option<&ByteString> where
    Q: AsRef<[u8]>, 

Returns a reference to the header value.

Examples

use envoy::host::HeaderMap;

let mut headers = HeaderMap::builder()
    .header(":authority", "example.org")
    .build();

assert_eq!(headers.get(":authority"), Some(&"example.org".into()));
assert_eq!(headers.get(":method"), None);

pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<ByteString> where
    K: Into<ByteString>,
    V: Into<ByteString>, 

Inserts a header.

If the header has not ben present before, None is returned. Otherwise, the value is updated, and the old value is returned.

Examples

use envoy::host::HeaderMap;

let mut headers = HeaderMap::builder()
    .header(":authority", "example.org")
    .build();

assert_eq!(headers.insert(":authority", "example.com"), Some("example.org".into()));
assert_eq!(headers.insert(":method", "GET"), None);

pub fn remove<Q>(&mut self, key: Q) -> Option<ByteString> where
    Q: AsRef<[u8]>, 

Removes a header by name, returning its value.

Examples

use envoy::host::HeaderMap;

let mut headers = HeaderMap::builder()
    .header(":authority", "example.org")
    .header(":method", "GET")
    .build();

assert_eq!(headers.remove(":authority"), Some("example.org".into()));
assert_eq!(headers.remove("content-type"), None);

Trait Implementations

impl Clone for HeaderMap

fn clone(&self) -> HeaderMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMap

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

Formats the value using the given formatter.

impl Default for HeaderMap

fn default() -> HeaderMap

Returns the "default value" for a type.

impl Eq for HeaderMap

impl<'_, '_, '_> From<&'_ [(&'_ str, &'_ str)]> for HeaderMap

fn from(entries: &[(&str, &str)]) -> Self

Performs the conversion.

impl<'_> From<&'_ HeaderMap> for HeaderMap

fn from(other: &HeaderMap) -> Self

Performs the conversion.

impl From<Vec<(ByteString, ByteString)>> for HeaderMap

fn from(entries: Vec<(ByteString, ByteString)>) -> Self

Performs the conversion.

impl<'a> FromIterator<&'a (&'a str, &'a str)> for HeaderMap

fn from_iter<T: IntoIterator<Item = &'a (&'a str, &'a str)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(ByteString, ByteString)> for HeaderMap

fn from_iter<T: IntoIterator<Item = (ByteString, ByteString)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a HeaderMap

type Item = (&'a ByteString, &'a ByteString)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a>

Creates an iterator from a value.

impl IntoIterator for HeaderMap

type Item = (ByteString, ByteString)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl PartialEq<HeaderMap> for HeaderMap

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for HeaderMap

impl StructuralPartialEq for HeaderMap