Struct hyperx::header::Warning [−][src]
pub struct Warning {
pub code: u16,
pub agent: String,
pub text: String,
pub date: Option<HttpDate>,
}
Expand description
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::{TypedHeaders, Warning};
let mut headers = http::HeaderMap::new();
headers.encode(
&Warning {
code: 299,
agent: "api.hyper.rs".to_owned(),
text: "Deprecated".to_owned(),
date: None
}
);
use hyperx::header::{TypedHeaders, HttpDate, Warning};
let mut headers = http::HeaderMap::new();
headers.encode(
&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::{TypedHeaders, Warning};
let mut headers = http::HeaderMap::new();
headers.encode(
&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
The HeaderName
from the http crate for this header.
Auto Trait Implementations
impl RefUnwindSafe for Warning
impl UnwindSafe for Warning
Blanket Implementations
Mutably borrows from an owned value. Read more