Struct headers::Origin

pub struct Origin(_);

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;

Methods

impl Origin

pub const NULL: Origin

The literal null Origin header.

pub fn is_null(&self) -> bool

Checks if Origin is null.

pub fn scheme(&self) -> &str

Get the "scheme" part of this origin.

pub fn hostname(&self) -> &str

Get the "hostname" part of this origin.

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

Get the "port" part of this origin.

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.

Trait Implementations

impl Eq for Origin

impl Clone for Origin

fn clone(&self) -> Origin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Origin> for Origin

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

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

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

This method tests for !=.

impl Hash for Origin

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Display for Origin

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

Formats the value using the given formatter.

impl Debug for Origin

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

Formats the value using the given formatter.

impl Header for Origin

fn name() -> &'static HeaderName

The name of this header.

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

Decode this type from an iterator of HeaderValues.

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

Encode this type to a HeaderMap.