Struct sequoia_rfc2822::NameAddrOrOther

pub struct NameAddrOrOther { /* fields omitted */ }

A parsed RFC 2822 name-addr, which also recognizes invalid email addresses.

name-addrs are typically of the form:

First Last (Comment) <email@example.org>

The name and comment are optional, but the comment is only allowed if there is also a name.

Note: this does not recognize bare addresses. That is, the angle brackets are required and the following is not recognized (even as an invalid address) as a name-addr:

email@example.org

This version of the name-addr parser also recognizes invalid email addresses. For instance:

First Last (Comment) <ssh://server.example.net>

will be successfully parsed. In this case, NameAddrOrOther::address() will return the parse error, and the invalid address can be obtained using NameAddrOrOther::other().

Methods

impl NameAddrOrOther

pub fn parse<S>(input: S) -> Result<Self> where
    S: AsRef<str>, 

Parses a string that allegedly contains an RFC 2822 name-addr with an optionally invalid email address.

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

Returns the display name.

pub fn comment(&self) -> Option<&str>

Returns the first comment.

pub fn address(&self) -> Result<&str>

Returns the address, if any.

If the address is invalid, then the parse error is returned.

pub fn other(&self) -> Option<&str>

Returns the invalid address, if any.

If the address is valid, then this returns None.

Trait Implementations

impl Eq for NameAddrOrOther

impl Clone for NameAddrOrOther

fn clone(&self) -> NameAddrOrOther

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<NameAddrOrOther> for NameAddrOrOther

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

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

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

This method tests for !=.

impl Debug for NameAddrOrOther

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

Formats the value using the given formatter.