Struct mail_headers::header_components::Phrase

pub struct Phrase(pub Vec1<Word>);

Represent a "phrase" as it for example is used in the Mailbox type for the display name.

It is recommended to use the [Phrase.new()] constructor, which creates the right phrase for your input.

Warning: Details of this type, expect Phrase::new and Phrase::try_from, are likely to change with some of the coming braking changes. If you just create it using try_from or new changes should not affect you, but if you create it from a vec of Word's things might be different.

Methods

impl Phrase

pub fn new<T: HeaderTryInto<Input>>(
    input: T
) -> Result<Self, ComponentCreationError>

Creates a Phrase instance from some arbitrary input.

This method can be used with both &str and String.

Error

There are only two cases in which this can fail:

1. If the input is empty (a phrase can not be empty).
2. If the input contained a illegal us-ascii character (any char which is not "visible" and not ' ' or \t like e.g. CTRL chars '\0' but also '\r' and '\n'). While we could encode them with encoded words, it's not really meant to be used this way and this chars will likely either be stripped out by a mail client or might cause display bugs.

Trait Implementations

impl<'a> HeaderTryFrom<&'a str> for Phrase

fn try_from(input: &'a str) -> Result<Self, ComponentCreationError>

impl HeaderTryFrom<String> for Phrase

fn try_from(input: String) -> Result<Self, ComponentCreationError>

impl HeaderTryFrom<Input> for Phrase

fn try_from(input: Input) -> Result<Self, ComponentCreationError>

impl PartialEq<Phrase> for Phrase

fn eq(&self, other: &Phrase) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Phrase) -> bool

This method tests for !=.

impl Clone for Phrase

fn clone(&self) -> Phrase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Phrase

impl Debug for Phrase

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

Formats the value using the given formatter.

impl Hash for Phrase

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl EncodableInHeader for Phrase

fn encode(&self, heandle: &mut EncodingWriter) -> Result<(), EncodingError>

fn boxed_clone(&self) -> Box<dyn EncodableInHeader>