Struct Header 

#[non_exhaustive]
pub struct Header { /* private fields */ }

A single message header line.

Implementations

impl Header

pub fn name(&self) -> &str

pub fn value(&self) -> &str

pub fn new( name: impl Into<String>, value: impl Into<String>, ) -> Result<Self, HeaderValidationError>

Constructs a header after validating name and value.

Name validation

The name must be non-empty and use only the RFC 5322 §2.2 ftext byte range (0x21..=0x39 | 0x3B..=0x7E). That is the literal grammar definition: it admits punctuation such as @, (, ), ,, <, >, [, ], ?, =, \, ". Conventional header names use the narrower RFC 7230 §3.2.6 token shape (alphanumerics plus a small punctuation set). Real MTAs and provider HTTP-header maps reject the looser superset; if you produce non-token names here the message will still pass kernel validation but will be dropped or routed to spam by most receivers. Callers needing the token shape should validate themselves before calling this constructor.

Errors

Returns HeaderValidationError when the name uses bytes outside the RFC 5322 set or the value contains raw newlines or non-tab control characters.

Trait Implementations

impl<'a> Arbitrary<'a> for Header

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Header

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Header

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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Header

impl StructuralPartialEq for Header