Struct Claims 

#[non_exhaustive]
pub struct Claims {
    pub root: String,
    pub publish: Vec<String>,
    pub subscribe: Vec<String>,
    pub expires: Option<SystemTime>,
    pub issued: Option<SystemTime>,
}

The payload of a token: a root, plus the publish/subscribe prefixes granted beneath it.

Build one from Default with the with_* setters, sign it with Key::sign, and scope it to a connection with authorize.

let claims = moq_token::Claims::default()
    .with_root("room/123")
    .with_publish(["alice"])
    .with_subscribe([""]);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

root: String

The root for the publish/subscribe options below. It’s mostly for compression and is optional, defaulting to the empty string.

publish: Vec<String>

If specified, the user can publish any matching broadcasts. If not specified, the user will not publish any broadcasts.

subscribe: Vec<String>

If specified, the user can subscribe to any matching broadcasts. If not specified, the user will not receive announcements and cannot subscribe to any broadcasts.

expires: Option<SystemTime>

The expiration time of the token as a unix timestamp.

issued: Option<SystemTime>

The issued time of the token as a unix timestamp.

Implementations

impl Claims

pub fn with_root(self, root: impl Into<String>) -> Self

Set the root that the publish/subscribe prefixes are relative to.

pub fn with_publish( self, paths: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Grant publish access to these prefixes, relative to the root.

pub fn with_subscribe( self, paths: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Grant subscribe access to these prefixes, relative to the root.

pub fn with_expires(self, at: impl Into<Option<SystemTime>>) -> Self

Expire the token at this time. Enforced by Key::verify.

Accepts an Option so a caller can pass one through without unwrapping it.

pub fn with_issued(self, at: impl Into<Option<SystemTime>>) -> Self

Record when the token was issued. Purely informational; nothing enforces it.

Accepts an Option so a caller can pass one through without unwrapping it.

pub fn validate(&self) -> Result<()>

Returns an error when the token grants nothing at all, making it useless.

pub fn authorize(&self, path: &str) -> Result<Permissions>

The access these claims grant at path, rebased so each returned prefix is relative to path.

path and root must overlap, in either direction:

• path extends the root (root demo, path demo/room), so the extra room narrows each prefix and drops the ones outside it.
• path is a parent of the root (root demo, path ``), so demo is prepended to each prefix to keep it anchored where the token points.

Matching is segment-aware, so a root of foo does not cover foobar. Slashes at the boundaries are implicit: /demo/ and demo are the same path.

Returns Error::RootMismatch when the two don’t overlap, and Error::NoAccess when they do but every prefix falls outside path.

This is authorization only. Verify the signature first with Key::verify, which is where expiry is enforced.

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Claims

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Claims

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

Formats the value using the given formatter.

impl Default for Claims

fn default() -> Claims

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Claims

where Claims: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Claims

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.