Struct rocket::http::Header

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<'_> Display for Header<'_>

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

Formats the value using the given formatter. Read more

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. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl<'h> PartialEq<Header<'h>> 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 ==. Read more

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

This method tests for !=.

impl<'h> Eq for Header<'h>

impl<'h> StructuralEq for Header<'h>

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

Auto Trait Implementations

impl<'h> RefUnwindSafe for Header<'h>

impl<'h> Send for Header<'h>

impl<'h> Sync for Header<'h>

impl<'h> Unpin for Header<'h>

impl<'h> UnwindSafe for Header<'h>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,

fn implicit(
    self,
    class: Class,
    constructed: bool,
    tag: u32
) -> TaggedParser<'a, Implicit, Self>

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoCollection<T> for T

fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,

Converts self into a collection.

fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more