Struct headers::common::origin::Origin

source ·
pub struct Origin(OriginOrNull);
Expand description

The Origin header.

The Origin header is a version of the Referer header that is used for all HTTP fetches and POSTs whose CORS flag is set. This header is often used to inform recipients of the security context of where the request was initiated.

Following the spec, https://fetch.spec.whatwg.org/#origin-header, the value of this header is composed of a String (scheme), Host (host/port)

§Examples

use headers::Origin;

let origin = Origin::NULL;

Tuple Fields§

§0: OriginOrNull

Implementations§

source§

impl Origin

source

pub const NULL: Origin = _

The literal null Origin header.

source

pub fn is_null(&self) -> bool

Checks if Origin is null.

source

pub fn scheme(&self) -> &str

Get the “scheme” part of this origin.

source

pub fn hostname(&self) -> &str

Get the “hostname” part of this origin.

source

pub fn port(&self) -> Option<u16>

Get the “port” part of this origin.

source

pub fn try_from_parts( scheme: &str, host: &str, port: impl Into<Option<u16>>, ) -> Result<Self, InvalidOrigin>

Tries to build a Origin from three parts, the scheme, the host and an optional port.

source

pub(super) fn try_from_value(value: &HeaderValue) -> Option<Self>

source

pub(super) fn into_value(&self) -> HeaderValue

Trait Implementations§

source§

impl Clone for Origin

source§

fn clone(&self) -> Origin

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
source§

impl Debug for Origin

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Origin

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Origin

source§

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

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, Self: Sized,

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

impl Header for Origin

source§

fn name() -> &'static HeaderName

The name of this header.
source§

fn decode<'i, I>(values: &mut I) -> Result<Self, Error>
where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.
source§

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap. Read more
source§

impl PartialEq for Origin

source§

fn eq(&self, other: &Origin) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for Origin

source§

impl StructuralPartialEq for Origin

Auto Trait Implementations§

§

impl !Freeze for Origin

§

impl RefUnwindSafe for Origin

§

impl Send for Origin

§

impl Sync for Origin

§

impl Unpin for Origin

§

impl UnwindSafe for Origin

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.