Struct saphir::header::Warning

pub struct Warning {
    pub code: u16,
    pub agent: String,
    pub text: String,
    pub date: Option<HttpDate>,
}

Warning header, defined in RFC7234

The Warning header field can be be used to carry additional information about the status or transformation of a message that might not be reflected in the status code. This header is sometimes used as backwards compatible way to notify of a deprecated API.

ABNF

Warning       = 1#warning-value
warning-value = warn-code SP warn-agent SP warn-text
                                      [ SP warn-date ]
warn-code  = 3DIGIT
warn-agent = ( uri-host [ ":" port ] ) / pseudonym
                ; the name or pseudonym of the server adding
                ; the Warning header field, for use in debugging
                ; a single "-" is recommended when agent unknown
warn-text  = quoted-string
warn-date  = DQUOTE HTTP-date DQUOTE

Example values

• Warning: 112 - "network down" "Sat, 25 Aug 2012 23:34:45 GMT"
• Warning: 299 - "Deprecated API " "Tue, 15 Nov 1994 08:12:31 GMT"
• Warning: 299 api.hyper.rs:8080 "Deprecated API : use newapi.hyper.rs instead."
• Warning: 299 api.hyper.rs:8080 "Deprecated API : use newapi.hyper.rs instead." "Tue, 15 Nov 1994 08:12:31 GMT"

Examples

use hyperx::header::{Headers, Warning};

let mut headers = Headers::new();
headers.set(
    Warning{
        code: 299,
        agent: "api.hyper.rs".to_owned(),
        text: "Deprecated".to_owned(),
        date: None
    }
);

use hyperx::header::{Headers, HttpDate, Warning};

let mut headers = Headers::new();
headers.set(
    Warning{
        code: 299,
        agent: "api.hyper.rs".to_owned(),
        text: "Deprecated".to_owned(),
        date: "Tue, 15 Nov 1994 08:12:31 GMT".parse::<HttpDate>().ok()
    }
);

use std::time::SystemTime;
use hyperx::header::{Headers, Warning};

let mut headers = Headers::new();
headers.set(
    Warning{
        code: 199,
        agent: "api.hyper.rs".to_owned(),
        text: "Deprecated".to_owned(),
        date: Some(SystemTime::now().into())
    }
);

Fields

code: u16

The 3 digit warn code.

agent: String

The name or pseudonym of the server adding this header.

text: String

The warning message describing the error.

date: Option<HttpDate>

An optional warning date.

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Warning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Warning

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

Formats the value using the given formatter.

impl Display for Warning

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

Formats the value using the given formatter.

impl FromStr for Warning

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Warning, Error>

Parses a string s to return a value of this type.

impl Header for Warning

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &Raw) -> Result<Warning, Error>

Parse a header from a raw stream of bytes.

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

Format a header to outgoing stream.

impl PartialEq<Warning> for Warning

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Warning