Struct EnrichedHeaders

pub struct EnrichedHeaders { /* private fields */ }

An HTTP/3 HEADERS frame with decoded headers and a HeaderMap.

Implementations

impl EnrichedHeaders

pub fn headers(&self) -> &[Header]

Return the array of headers in this frame.

Examples

use h3i::frame::EnrichedHeaders;
use quiche::h3::Header;

let raw = vec![
    Header::new(b"new jersey", b"devils"),
    Header::new(b"new york", b"jets"),
];
let headers = EnrichedHeaders::from(raw.clone());
assert_eq!(headers.headers(), raw);

pub fn header_map(&self) -> &HeaderMap

Returns a multi-map of header keys to values.

If a single key contains multiple values, the values in the entry will be returned in the same order as they appear in the array of headers which backs the EnrichedHeaders.

Examples

use h3i::frame::EnrichedHeaders;
use h3i::frame::H3iFrame;
use multimap::MultiMap;
use quiche::h3::Header;
use std::iter::FromIterator;

let header_frame = vec![
    Header::new(b":status", b"200"),
    Header::new(b"hello", b"world"),
    Header::new(b"hello", b"super-earth"),
];

let enriched = H3iFrame::Headers(header_frame.into())
    .to_enriched_headers()
    .unwrap();

let expected = MultiMap::from_iter([
    (b":status".to_vec(), vec![b"200".to_vec()]),
    (b"hello".to_vec(), vec![
        b"world".to_vec(),
        b"super-earth".to_vec(),
    ]),
]);

assert_eq!(*enriched.header_map(), expected);

pub fn status_code(&self) -> Option<&Vec<u8>>

Fetches the value of the :status pseudo-header.

Examples

use h3i::frame::EnrichedHeaders;
use quiche::h3::Header;

let headers = EnrichedHeaders::from(vec![Header::new(b"hello", b"world")]);
assert!(headers.status_code().is_none());

let headers = EnrichedHeaders::from(vec![Header::new(b":status", b"200")]);
assert_eq!(headers.status_code().expect("status code is Some"), b"200");

Trait Implementations

impl Clone for EnrichedHeaders

fn clone(&self) -> EnrichedHeaders

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnrichedHeaders

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

Formats the value using the given formatter.

impl From<Vec<Header>> for EnrichedHeaders

fn from(headers: Vec<Header>) -> Self

Converts to this type from the input type.

impl PartialEq for EnrichedHeaders

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

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Frame> for EnrichedHeaders

type Error = Box<dyn Error + Send + Sync>

The type returned in the event of a conversion error.

fn try_from(value: QFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for EnrichedHeaders

impl StructuralPartialEq for EnrichedHeaders