Struct hyper::header::Warning [] [src]

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

Examples

use hyper::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 hyper::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 hyper::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

The 3 digit warn code.

The name or pseudonym of the server adding this header.

The warning message describing the error.

An optional warning date.

Trait Implementations

impl PartialEq for Warning
[src]

[src]

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

[src]

This method tests for !=.

impl Clone for Warning
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for Warning
[src]

[src]

Formats the value using the given formatter.

impl Header for Warning
[src]

[src]

Returns the name of the header field this belongs to. Read more

[src]

Parse a header from a raw stream of bytes. Read more

[src]

Format a header to outgoing stream. Read more

impl Display for Warning
[src]

[src]

Formats the value using the given formatter. Read more

impl FromStr for Warning
[src]

The associated error which can be returned from parsing.

[src]

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