Trait lettre::message::header::Header

pub trait Header: 'static + HeaderClone + Send + Sync {
    fn header_name() -> &'static str;
    fn parse_header<'a, T>(raw: &'a T) -> Result<Self, Error>
    where
        T: RawLike<'a>;
    fn fmt_header(&self, f: &mut Formatter<'_, '_>) -> Result<(), Error>;
}

A trait for any object that will represent a header field and value.

This trait represents the construction and identification of headers, and contains trait-object unsafe methods.

Required methods

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

This will become an associated constant once available.

fn parse_header<'a, T>(raw: &'a T) -> Result<Self, Error> where
    T: RawLike<'a>, 

Parse a header from a raw stream of bytes.

It's possible that a request can include a header field more than once, and in that case, the slice will have a length greater than 1. However, it's not necessarily the case that a Header is allowed to have more than one field value. If that's the case, you should return None if raw.len() > 1.

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

Format a header to outgoing stream.

Most headers should be formatted on one line, and so a common pattern would be to implement std::fmt::Display for this type as well, and then just call f.fmt_line(self).

Note

This has the ability to format a header over multiple lines.

The main example here is Set-Cookie, which requires that every cookie being set be specified in a separate line. Almost every other case should only format as 1 single line.

Loading content...

Implementations on Foreign Types

impl Header for Vary

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Vary, Error> where
    T: RawLike<'a>, 

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

impl Header for Warning

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Warning, Error> where
    T: RawLike<'a>, 

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

impl Header for Server

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Server, Error> where
    T: RawLike<'a>, 

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

impl Header for AcceptCharset

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AcceptCharset, Error> where
    T: RawLike<'a>, 

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

impl Header for ETag

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ETag, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlAllowOrigin

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlAllowOrigin, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentRange

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentRange, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlRequestHeaders

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlRequestHeaders, Error> where
    T: RawLike<'a>, 

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

impl Header for AcceptLanguage

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AcceptLanguage, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentLength

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentLength, Error> where
    T: RawLike<'a>, 

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

impl Header for Link

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Link, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentLanguage

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentLanguage, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlMaxAge

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlMaxAge, Error> where
    T: RawLike<'a>, 

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

impl Header for Upgrade

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Upgrade, Error> where
    T: RawLike<'a>, 

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

impl Header for Referer

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Referer, Error> where
    T: RawLike<'a>, 

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

impl Header for Cookie

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Cookie, Error> where
    T: RawLike<'a>, 

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

impl Header for Connection

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Connection, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlExposeHeaders

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlExposeHeaders, Error> where
    T: RawLike<'a>, 

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

impl Header for IfRange

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<IfRange, Error> where
    T: RawLike<'a>, 

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

impl Header for UserAgent

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<UserAgent, Error> where
    T: RawLike<'a>, 

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

impl Header for Expires

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Expires, Error> where
    T: RawLike<'a>, 

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

impl Header for ReferrerPolicy

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ReferrerPolicy, Error> where
    T: RawLike<'a>, 

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

impl Header for TransferEncoding

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<TransferEncoding, Error> where
    T: RawLike<'a>, 

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

impl Header for IfMatch

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<IfMatch, Error> where
    T: RawLike<'a>, 

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

impl Header for IfModifiedSince

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<IfModifiedSince, Error> where
    T: RawLike<'a>, 

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

impl Header for LastEventId

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<LastEventId, Error> where
    T: RawLike<'a>, 

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

impl Header for IfUnmodifiedSince

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<IfUnmodifiedSince, Error> where
    T: RawLike<'a>, 

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

impl Header for Prefer

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Prefer, Error> where
    T: RawLike<'a>, 

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

impl Header for Host

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Host, Error> where
    T: RawLike<'a>, 

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

impl Header for From

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<From, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlAllowHeaders

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlAllowHeaders, Error> where
    T: RawLike<'a>, 

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

impl<S> Header for ProxyAuthorization<S> where
    S: Scheme + Any,
    <S as FromStr>::Err: 'static, 

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ProxyAuthorization<S>, Error> where
    T: RawLike<'a>, 

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

impl Header for IfNoneMatch

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<IfNoneMatch, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlRequestMethod

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlRequestMethod, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentEncoding

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentEncoding, Error> where
    T: RawLike<'a>, 

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

impl Header for Origin

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Origin, Error> where
    T: RawLike<'a>, 

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

impl Header for AcceptRanges

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AcceptRanges, Error> where
    T: RawLike<'a>, 

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

impl Header for SetCookie

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<SetCookie, Error> where
    T: RawLike<'a>, 

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

impl Header for RetryAfter

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<RetryAfter, Error> where
    T: RawLike<'a>, 

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

impl Header for AcceptEncoding

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AcceptEncoding, Error> where
    T: RawLike<'a>, 

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

impl Header for Accept

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Accept, Error> where
    T: RawLike<'a>, 

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

impl<S> Header for Authorization<S> where
    S: Scheme + Any,
    <S as FromStr>::Err: 'static, 

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Authorization<S>, Error> where
    T: RawLike<'a>, 

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

impl Header for LastModified

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<LastModified, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlAllowMethods

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<AccessControlAllowMethods, Error> where
    T: RawLike<'a>, 

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

impl Header for AccessControlAllowCredentials

fn header_name() -> &'static str

fn parse_header<'a, T>(
    raw: &'a T
) -> Result<AccessControlAllowCredentials, Error> where
    T: RawLike<'a>, 

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

impl Header for Expect

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Expect, Error> where
    T: RawLike<'a>, 

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

impl Header for Pragma

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Pragma, Error> where
    T: RawLike<'a>, 

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

impl Header for Allow

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Allow, Error> where
    T: RawLike<'a>, 

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

impl Header for Te

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Te, Error> where
    T: RawLike<'a>, 

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

impl Header for CacheControl

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<CacheControl, Error> where
    T: RawLike<'a>, 

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

impl Header for Location

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Location, Error> where
    T: RawLike<'a>, 

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

impl Header for Range

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Range, Error> where
    T: RawLike<'a>, 

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

impl Header for PreferenceApplied

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<PreferenceApplied, Error> where
    T: RawLike<'a>, 

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

impl Header for StrictTransportSecurity

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<StrictTransportSecurity, Error> where
    T: RawLike<'a>, 

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

Loading content...

Implementors

impl Header for ContentTransferEncoding

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Self> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Bcc

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Bcc> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Cc

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Cc> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Comments

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Comments> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for ContentDisposition

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentDisposition, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentLocation

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentLocation, Error> where
    T: RawLike<'a>, 

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

impl Header for ContentType

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentType, Error> where
    T: RawLike<'a>, 

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

impl Header for Date

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> Result<Date, Error> where
    T: RawLike<'a>, 

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

impl Header for lettre::message::header::From

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<From> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for InReplyTo

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<InReplyTo> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Keywords

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Keywords> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for MessageId

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<MessageId> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for MimeVersion

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Self> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for References

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<References> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for ReplyTo

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<ReplyTo> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Sender

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Self> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for Subject

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<Subject> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for To

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<To> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

impl Header for lettre::message::header::UserAgent

fn header_name() -> &'static str

fn parse_header<'a, T>(raw: &'a T) -> HyperResult<UserAgent> where
    T: RawLike<'a>,
    Self: Sized, 

fn fmt_header(&self, f: &mut HeaderFormatter<'_, '_>) -> FmtResult

Loading content...