Struct rocket::http::Header

pub struct Header<'h> {
    pub name: Uncased<'h>,
    pub value: Cow<'h, str>,
}

Simple representation of an HTTP header.

Fields

name: Uncased<'h>

The name of the header.

value: Cow<'h, str>

The value of the header.

Implementations

impl<'h> Header<'h>

pub fn new<'a, 'b, N, V>(name: N, value: V) -> Header<'h>

where 'a: 'h, 'b: 'h, N: Into<Cow<'a, str>>, V: Into<Cow<'b, str>>,

Constructs a new header. This method should be used rarely and only for non-standard headers. Instead, prefer to use the Into<Header> implementations of many types, including [ContentType] and all of the headers in http::hyper::header.

Examples

Create a custom header with name X-Custom-Header and value custom value.

use rocket::http::Header;

let header = Header::new("X-Custom-Header", "custom value");
assert_eq!(header.to_string(), "X-Custom-Header: custom value");

Use a String as a value to do the same.

use rocket::http::Header;

let value = format!("{} value", "custom");
let header = Header::new("X-Custom-Header", value);
assert_eq!(header.to_string(), "X-Custom-Header: custom value");

pub fn name(&self) -> &str

Returns the name of this header with casing preserved. To do a case-insensitive equality check, use .name directly.

Example

A case-sensitive equality check:

use rocket::http::Header;

let value = format!("{} value", "custom");
let header = Header::new("X-Custom-Header", value);
assert_eq!(header.name(), "X-Custom-Header");
assert!(header.name() != "X-CUSTOM-HEADER");

A case-insensitive equality check via .name:

use rocket::http::Header;

let header = Header::new("X-Custom-Header", "custom value");
assert_eq!(header.name, "X-Custom-Header");
assert_eq!(header.name, "X-CUSTOM-HEADER");

pub fn value(&self) -> &str

Returns the value of this header.

Example

A case-sensitive equality check:

use rocket::http::Header;

let header = Header::new("X-Custom-Header", "custom value");
assert_eq!(header.value(), "custom value");

Trait Implementations

impl<'h> Clone for Header<'h>

fn clone(&self) -> Header<'h>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'h> Debug for Header<'h>

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

Formats the value using the given formatter.

impl<'h> Display for Header<'h>

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

Formats the value using the given formatter.

impl<'a, 'c> From<&'a Cookie<'c>> for Header<'static>

fn from(cookie: &Cookie<'_>) -> Header<'static>

Converts to this type from the input type.

impl From<Accept> for Header<'static>

fn from(header: Accept) -> Header<'static>

Converts to this type from the input type.

impl From<AcceptCharset> for Header<'static>

fn from(header: AcceptCharset) -> Header<'static>

Converts to this type from the input type.

impl From<AcceptEncoding> for Header<'static>

fn from(header: AcceptEncoding) -> Header<'static>

Converts to this type from the input type.

impl From<AcceptLanguage> for Header<'static>

fn from(header: AcceptLanguage) -> Header<'static>

Converts to this type from the input type.

impl From<AcceptRanges> for Header<'static>

fn from(header: AcceptRanges) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlAllowCredentials> for Header<'static>

fn from(header: AccessControlAllowCredentials) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlAllowHeaders> for Header<'static>

fn from(header: AccessControlAllowHeaders) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlAllowMethods> for Header<'static>

fn from(header: AccessControlAllowMethods) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlAllowOrigin> for Header<'static>

fn from(header: AccessControlAllowOrigin) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlExposeHeaders> for Header<'static>

fn from(header: AccessControlExposeHeaders) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlMaxAge> for Header<'static>

fn from(header: AccessControlMaxAge) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlRequestHeaders> for Header<'static>

fn from(header: AccessControlRequestHeaders) -> Header<'static>

Converts to this type from the input type.

impl From<AccessControlRequestMethod> for Header<'static>

fn from(header: AccessControlRequestMethod) -> Header<'static>

Converts to this type from the input type.

impl From<Allow> for Header<'static>

fn from(header: Allow) -> Header<'static>

Converts to this type from the input type.

impl From<CacheControl> for Header<'static>

fn from(header: CacheControl) -> Header<'static>

Converts to this type from the input type.

impl From<Connection> for Header<'static>

fn from(header: Connection) -> Header<'static>

Converts to this type from the input type.

impl From<ContentDisposition> for Header<'static>

fn from(header: ContentDisposition) -> Header<'static>

Converts to this type from the input type.

impl From<ContentEncoding> for Header<'static>

fn from(header: ContentEncoding) -> Header<'static>

Converts to this type from the input type.

impl From<ContentLanguage> for Header<'static>

fn from(header: ContentLanguage) -> Header<'static>

Converts to this type from the input type.

impl From<ContentLength> for Header<'static>

fn from(header: ContentLength) -> Header<'static>

Converts to this type from the input type.

impl From<ContentRange> for Header<'static>

fn from(header: ContentRange) -> Header<'static>

Converts to this type from the input type.

impl<'c> From<Cookie<'c>> for Header<'static>

fn from(cookie: Cookie<'_>) -> Header<'static>

Converts to this type from the input type.

impl From<Date> for Header<'static>

fn from(header: Date) -> Header<'static>

Converts to this type from the input type.

impl From<ETag> for Header<'static>

fn from(header: ETag) -> Header<'static>

Converts to this type from the input type.

impl From<Expect> for Header<'static>

fn from(header: Expect) -> Header<'static>

Converts to this type from the input type.

impl From<Expires> for Header<'static>

fn from(header: Expires) -> Header<'static>

Converts to this type from the input type.

impl From<Host> for Header<'static>

fn from(header: Host) -> Header<'static>

Converts to this type from the input type.

impl From<IfMatch> for Header<'static>

fn from(header: IfMatch) -> Header<'static>

Converts to this type from the input type.

impl From<IfModifiedSince> for Header<'static>

fn from(header: IfModifiedSince) -> Header<'static>

Converts to this type from the input type.

impl From<IfNoneMatch> for Header<'static>

fn from(header: IfNoneMatch) -> Header<'static>

Converts to this type from the input type.

impl From<IfRange> for Header<'static>

fn from(header: IfRange) -> Header<'static>

Converts to this type from the input type.

impl From<IfUnmodifiedSince> for Header<'static>

fn from(header: IfUnmodifiedSince) -> Header<'static>

Converts to this type from the input type.

impl From<LastModified> for Header<'static>

fn from(header: LastModified) -> Header<'static>

Converts to this type from the input type.

impl From<Location> for Header<'static>

fn from(header: Location) -> Header<'static>

Converts to this type from the input type.

impl From<Origin> for Header<'static>

fn from(header: Origin) -> Header<'static>

Converts to this type from the input type.

impl From<Pragma> for Header<'static>

fn from(header: Pragma) -> Header<'static>

Converts to this type from the input type.

impl From<Prefer> for Header<'static>

fn from(header: Prefer) -> Header<'static>

Converts to this type from the input type.

impl From<PreferenceApplied> for Header<'static>

fn from(header: PreferenceApplied) -> Header<'static>

Converts to this type from the input type.

impl From<Range> for Header<'static>

fn from(header: Range) -> Header<'static>

Converts to this type from the input type.

impl From<Referer> for Header<'static>

fn from(header: Referer) -> Header<'static>

Converts to this type from the input type.

impl From<ReferrerPolicy> for Header<'static>

fn from(header: ReferrerPolicy) -> Header<'static>

Converts to this type from the input type.

impl From<StrictTransportSecurity> for Header<'static>

fn from(header: StrictTransportSecurity) -> Header<'static>

Converts to this type from the input type.

impl From<TransferEncoding> for Header<'static>

fn from(header: TransferEncoding) -> Header<'static>

Converts to this type from the input type.

impl From<Upgrade> for Header<'static>

fn from(header: Upgrade) -> Header<'static>

Converts to this type from the input type.

impl From<UserAgent> for Header<'static>

fn from(header: UserAgent) -> Header<'static>

Converts to this type from the input type.

impl From<Vary> for Header<'static>

fn from(header: Vary) -> Header<'static>

Converts to this type from the input type.

impl<'h> Hash for Header<'h>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<Header<'static>> for Accept

Creates a new Header with name Accept and the value set to the HTTP rendering of this Accept header.

fn into(self) -> Header<'static>

Converts this type into the (usually inferred) input type.

impl Into<Header<'static>> for ContentType

Creates a new Header with name Content-Type and the value set to the HTTP rendering of this Content-Type.

fn into(self) -> Header<'static>

Converts this type into the (usually inferred) input type.

impl<'h> PartialEq for Header<'h>

fn eq(&self, other: &Header<'h>) -> 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<'h> Eq for Header<'h>

impl<'h> StructuralPartialEq for Header<'h>