Struct Origin

pub struct Origin(/* private fields */);

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), header::Host (host/port)

Examples

use hyperx::header::{Origin, TypedHeaders};

let mut headers = http::HeaderMap::new();
headers.encode(
    &Origin::new("http", "hyper.rs", None)
);

use hyperx::header::{Origin, TypedHeaders};

let mut headers = http::HeaderMap::new();
headers.encode(
    &Origin::new("https", "wikipedia.org", Some(443))
);

Implementations

impl Origin

pub fn new<S: Into<Cow<'static, str>>, H: Into<Cow<'static, str>>>( scheme: S, hostname: H, port: Option<u16>, ) -> Origin

Creates a new Origin header.

pub fn null() -> Origin

Creates a Null Origin header.

pub fn is_null(&self) -> bool

Checks if Origin is Null.

pub fn scheme(&self) -> Option<&str>

The scheme, such as http or https.

use hyperx::header::Origin;
let origin = Origin::new("https", "foo.com", Some(443));
assert_eq!(origin.scheme(), Some("https"));

pub fn host(&self) -> Option<&Host>

The host, such as Host { hostname: "hyper.rs".to_owned(), port: None}.

use hyperx::header::{Origin,Host};
let origin = Origin::new("https", "foo.com", Some(443));
assert_eq!(origin.host(), Some(&Host::new("foo.com", Some(443))));

Trait Implementations

impl Clone for Origin

fn clone(&self) -> Origin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Origin

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

Formats the value using the given formatter.

impl Display for Origin

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

Formats the value using the given formatter.

impl FromStr for Origin

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Origin>

Parses a string s to return a value of this type.

impl Header for Origin

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header<'a, T>(raw: &'a T) -> Result<Origin>

where T: RawLike<'a>,

Parse a header from a raw stream of bytes.

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

Format a header to outgoing stream.

impl PartialEq for Origin

fn eq(&self, other: &Origin) -> 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 StandardHeader for Origin

fn http_header_name() -> HeaderName

The HeaderName from the http crate for this header.

impl StructuralPartialEq for Origin