Struct hpack_codec::field::LiteralHeaderField

pub struct LiteralHeaderField<'a> { /* fields omitted */ }

Literal representation of a header field.

See: 6.2. Literal Header Field Representation

Methods

impl<'a> LiteralHeaderField<'a>

pub fn new(name: &'a [u8], value: &'a [u8]) -> Self

Makes a new LiteralHeaderField instance.

Examples

use hpack_codec::field::{LiteralHeaderField, LiteralFieldForm};;

let field = LiteralHeaderField::new(b"foo", b"bar");
assert_eq!(field.form(), LiteralFieldForm::WithoutIndexing);

pub fn with_indexed_name<N>(name: N, value: &'a [u8]) -> Self where
    N: Into<Index>, 

Makes a new LiteralHeaderField instance with the specified indexed name.

Examples

use hpack_codec::field::{LiteralHeaderField, LiteralFieldForm};;
use hpack_codec::table::{Index, StaticEntry};

// Uses an index of the static table.
let field = LiteralHeaderField::with_indexed_name(StaticEntry::Method, b"foo");

// Uses an index of a dynamic table;
let field = LiteralHeaderField::with_indexed_name(Index::dynamic_table_offset() + 2, b"bar");

pub fn with_indexing(self) -> Self

Specifies to index this header field into a dynamic table.

pub fn never_indexed(self) -> Self

Specifies that this header field will be never indexed into a dynamic table.

pub fn with_huffman_encoded_name(self) -> Self

Encodes the name of this header field by huffman coding.

pub fn with_huffman_encoded_value(self) -> Self

Encodes the value of this header field by huffman coding.

pub fn name(&self) -> &FieldName

Returns the name of this header field.

pub fn value(&self) -> &HpackString

Returns the value of this header field.

pub fn form(&self) -> LiteralFieldForm

Returns the form of this header field.

Trait Implementations

impl<'a> From<LiteralHeaderField<'a>> for RawHeaderField<'a>

fn from(f: LiteralHeaderField<'a>) -> Self

Performs the conversion.

impl<'a> Debug for LiteralHeaderField<'a>

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

Formats the value using the given formatter.