Struct Grant 

#[non_exhaustive]
pub struct Grant {
    pub publish: Patterns,
    pub subscribe: Patterns,
    pub root: Option<String>,
    pub expires: Option<SystemTime>,
    pub revalidate: Option<Duration>,
    pub tier: Option<String>,
    pub peer: bool,
}

What a session may do, as the auth server answered.

A 2xx carrying one of these admits; anything else refuses. A grant that names nothing is a refusal too, and one that asks to be revalidated must say when it expires, so an outage always has a bound the server chose. validate checks these once at the boundary.

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.

publish: Patterns

Patterns the session may publish, relative to the root.

subscribe: Patterns

Patterns the session may subscribe to, relative to the root.

root: Option<String>

The path the patterns are relative to, replacing the dialed one. This is how a server aliases a slug to a canonical id. Absent means the dialed path.

expires: Option<SystemTime>

When the session closes, as unix seconds.

revalidate: Option<Duration>

How long until the relay asks again, in seconds.

tier: Option<String>

An opaque label handed to stats, so traffic can be bucketed.

peer: bool

The session is a cluster peer (another relay): what it announces entered the cluster elsewhere, not here.

Implementations

impl Grant

pub fn new(publish: Patterns, subscribe: Patterns) -> Self

A grant of these patterns and nothing else.

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

Refuse a grant that admits nothing, asks to be revalidated without a bound or at no interval, or has already expired. A few seconds of clock skew are tolerated so an auth server whose clock runs behind still admits.

Trait Implementations

impl Clone for Grant

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Grant

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

Formats the value using the given formatter.

impl Default for Grant

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Grant

where Grant: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Grant

impl PartialEq for Grant

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Grant

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Grant