Struct Origin 

pub struct Origin<'a> {
    pub scheme: &'a [u8],
    pub host: Host<'a>,
    pub port: Option<u16>,
}

A serialized origin.

Fields

scheme: &'a [u8]

The scheme as sent (compare it ASCII case-insensitively).

host: Host<'a>

The host.

port: Option<u16>

The port, when one was given.

Implementations

impl Origin<'_>

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

The port, or the scheme’s default: 80 for http and ws, 443 for https and wss; None for another scheme without a port.

Examples

use parse_net::{parse_origin, OriginValue};

let OriginValue::Origin(o) = parse_origin(b"wss://chat.example")? else { unreachable!() };
assert_eq!(o.effective_port(), Some(443));

pub fn same_origin(&self, other: &Origin<'_>) -> bool

Whether two origins are the same: schemes and hosts equal as whole values (ASCII case-insensitive, IP literals by value), effective ports equal. Never a prefix or suffix comparison.

pub fn write_to(&self, out: &mut impl Sink) -> Result<(), WriteError>

Writes the origin with a lowercase scheme and without a default port.

Errors

WriteError::Full; nothing is written when the sink reports its room.

Examples

use parse_net::{parse_origin, OriginValue, SliceSink};

let OriginValue::Origin(o) = parse_origin(b"HTTPS://a.example:443")? else { unreachable!() };
let mut buf = [0u8; 64];
let mut out = SliceSink::new(&mut buf);
o.write_to(&mut out).expect("room");
assert_eq!(out.written(), b"https://a.example");

Trait Implementations

impl<'a> Clone for Origin<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Origin<'a>

impl<'a> Debug for Origin<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Origin<'a>

impl<'a> Hash for Origin<'a>

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

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Origin<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Origin<'a>