Struct Headers

pub struct Headers { /* private fields */ }

A set of email headers

Implementations

impl Headers

pub const fn new() -> Self

Create an empty Headers

This function does not allocate.

pub fn with_capacity(capacity: usize) -> Self

Create an empty Headers with a pre-allocated capacity

Pre-allocates a capacity of at least capacity.

pub fn get<H: Header>(&self) -> Option<H>

Returns a copy of an Header present in Headers

Returns None if Header isn’t present in Headers.

pub fn set<H: Header>(&mut self, header: H)

Sets Header into Headers, overriding Header if it was already present in Headers

pub fn remove<H: Header>(&mut self) -> Option<H>

Remove Header from Headers, returning it

Returns None if Header isn’t in Headers.

pub fn clear(&mut self)

Clears Headers, removing all headers from it

Any pre-allocated capacity is left untouched.

pub fn get_raw(&self, name: &str) -> Option<&str>

Returns a reference to the raw value of header name

Returns None if name isn’t present in Headers.

pub fn insert_raw(&mut self, value: HeaderValue)

Inserts a raw header into Headers, overriding value if it was already present in Headers.

pub fn remove_raw(&mut self, name: &str) -> Option<HeaderValue>

Remove a raw header from Headers, returning it

Returns None if name isn’t present in Headers.

Trait Implementations

impl Clone for Headers

fn clone(&self) -> Headers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Headers

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

Formats the value using the given formatter.

impl Default for Headers

fn default() -> Headers

Returns the “default value” for a type.

impl Display for Headers

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

Formats Headers, ready to put them into an email

impl TryFrom<&Headers> for Envelope

type Error = Error

The type returned in the event of a conversion error.

fn try_from(headers: &Headers) -> Result<Self, Self::Error>

Performs the conversion.