Struct OriginKey 

pub struct OriginKey { /* private fields */ }

The security principal a piece of stored state belongs to.

Storage is keyed by this and never by a URL. Two pages on one origin share storage; two pages on different origins must not see each other’s, and that is a security property rather than a nicety.

Derived through Url::origin, which is Servo’s implementation of the WHATWG origin concept, so the awkward cases are already decided: blob: unwraps to its inner origin, and file: and data: are opaque.

Opaque origins

Url::origin mints a fresh opaque origin on every call for a file: URL, so a document must derive its key once, at construction, and hold it. Deriving twice would give one document two identities and lose its own writes.

That is exactly the intended behaviour and not a wrinkle to route around. Collapsing every file: page into one shared bucket would mean any local HTML file could read any other’s saved state, which is the same class of mistake as blitz-net’s file: handler reading any path it is handed. One such hole is enough.

is_persistable is the flag a disk-backed provider must check: an opaque origin is unique to one instance of one document, so writing it to disk stores a row that can never be read again.

Implementations

impl OriginKey

pub fn for_document(url: &Url) -> OriginKey

The origin of a document loaded from url.

Call once per document and keep the result. See the type’s docs for why calling twice is a bug for file: and data: URLs.

pub fn opaque() -> OriginKey

A fresh opaque origin, shared with nothing.

The serialisation of every opaque origin is the string null, so it cannot be used to tell two of them apart. This appends a process-unique counter so that a provider keying an in-memory map on as_str isolates them from each other, which null alone would not.

pub fn as_str(&self) -> &str

A stable string for this origin, suitable as a map or table key.

Unique per origin, including across opaque ones. Not a URL, and not to be parsed back into one.

pub fn is_persistable(&self) -> bool

Whether state under this origin may be written to disk.

False for opaque origins. A provider that persists must check this and keep the rest in memory; see the type’s docs.

Trait Implementations

impl Clone for OriginKey

fn clone(&self) -> OriginKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OriginKey

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

Formats the value using the given formatter.

impl Eq for OriginKey

impl Hash for OriginKey

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

where __H: Hasher,

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 PartialEq for OriginKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OriginKey