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) -> &UncasedStr

Returns the name of this header.

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().as_str(), "X-Custom-Header");
assert_ne!(header.name().as_str(), "X-CUSTOM-HEADER");

A case-insensitive equality check:

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 Display for Header<'_>

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

Formats the value using the given formatter.

impl From<&Cookie<'_>> for Header<'static>

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

Converts to this type from the input type.

impl From<&ExpectCt> for Header<'static>

fn from(expect: &ExpectCt) -> Self

Converts to this type from the input type.

impl From<&Frame> for Header<'static>

fn from(frame: &Frame) -> Self

Converts to this type from the input type.

impl From<&Hsts> for Header<'static>

fn from(hsts: &Hsts) -> Self

Converts to this type from the input type.

impl From<&NoSniff> for Header<'static>

fn from(_: &NoSniff) -> Self

Converts to this type from the input type.

impl From<&Permission> for Header<'static>

fn from(perm: &Permission) -> Self

Converts to this type from the input type.

impl From<&Prefetch> for Header<'static>

fn from(prefetch: &Prefetch) -> Self

Converts to this type from the input type.

impl From<&Referrer> for Header<'static>

fn from(referrer: &Referrer) -> Self

Converts to this type from the input type.

impl From<&XssFilter> for Header<'static>

fn from(filter: &XssFilter) -> Self

Converts to this type from the input type.

impl From<Accept> for Header<'static>

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

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

Converts to this type from the input type.

impl From<ContentType> for Header<'static>

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

fn from(content_type: ContentType) -> Header<'static>

Converts to this type from the input type.

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

fn from(cookie: Cookie<'_>) -> 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<'h> PartialEq for Header<'h>

fn eq(&self, other: &Header<'h>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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>