Struct http_types::trailers::Trailers

pub struct Trailers { /* fields omitted */ }

A collection of trailing HTTP headers.

Implementations

impl Trailers

pub fn new() -> Self

Create a new instance of Trailers.

pub fn insert(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
) -> Option<HeaderValues>

Insert a header into the headers.

Examples

use http_types::Trailers;

let mut trailers = Trailers::new();
trailers.insert("Content-Type", "text/plain");

pub fn append(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
)

Append a header to the headers.

Unlike insert this function will not override the contents of a header, but insert a header if there aren't any. Or else append to the existing list of headers.

Examples

use http_types::Trailers;

let mut trailers = Trailers::new();
trailers.append("Content-Type", "text/plain");

pub fn get(&self, name: impl Into<HeaderName>) -> Option<&HeaderValues>

Get a reference to a header.

pub fn get_mut(
    &mut self,
    name: impl Into<HeaderName>
) -> Option<&mut HeaderValues>

Get a mutable reference to a header.

pub fn remove(&mut self, name: impl Into<HeaderName>) -> Option<HeaderValues>

Remove a header.

pub fn iter(&self) -> Iter

An iterator visiting all header pairs in arbitrary order.

pub fn iter_mut(&mut self) -> IterMut

An iterator visiting all header pairs in arbitrary order, with mutable references to the values.

pub fn names(&self) -> Names

An iterator visiting all header names in arbitrary order.

pub fn values(&self) -> Values

An iterator visiting all header values in arbitrary order.

Methods from Deref<Target = Headers>

pub fn insert(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
) -> Option<HeaderValues>

Insert a header into the headers.

Not that this will replace all header values for a given header name. If you wish to add header values for a header name that already exists use Headers::append

pub fn append(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
)

Append a header to the headers.

Unlike insert this function will not override the contents of a header, but insert a header if there aren't any. Or else append to the existing list of headers.

pub fn get(&self, name: impl Into<HeaderName>) -> Option<&HeaderValues>

Get a reference to a header.

pub fn get_mut(
    &mut self,
    name: impl Into<HeaderName>
) -> Option<&mut HeaderValues>

Get a mutable reference to a header.

pub fn remove(&mut self, name: impl Into<HeaderName>) -> Option<HeaderValues>

Remove a header.

pub fn iter(&self) -> Iter

An iterator visiting all header pairs in arbitrary order.

pub fn iter_mut(&mut self) -> IterMut

An iterator visiting all header pairs in arbitrary order, with mutable references to the values.

pub fn names(&self) -> Names

An iterator visiting all header names in arbitrary order.

pub fn values(&self) -> Values

An iterator visiting all header values in arbitrary order.

Trait Implementations

impl Clone for Trailers

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trailers

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

Formats the value using the given formatter.

impl Deref for Trailers

type Target = Headers

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Trailers

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'_> Index<&'_ str> for Trailers

type Output = HeaderValues

The returned type after indexing.

fn index(&self, name: &str) -> &HeaderValues

Returns a reference to the value corresponding to the supplied name.

Panics

Panics if the name is not present in Trailers.

impl Index<HeaderName> for Trailers

type Output = HeaderValues

The returned type after indexing.

fn index(&self, name: HeaderName) -> &HeaderValues

Returns a reference to the value corresponding to the supplied name.

Panics

Panics if the name is not present in Trailers.