Skip to main content

Passport

Struct Passport 

Source
pub struct Passport { /* private fields */ }
Expand description

The traveler’s held Passport: the token, its claims, and (once fetched) the descriptor. Fetching runs on a background thread; call Passport::poll once per frame, like the other Loom clients.

Implementations§

Source§

impl Passport

Source

pub fn from_token(token: impl Into<String>) -> Option<Self>

Hold a token. Claims decode best-effort — an opaque (non-JWT) dev token still carries, it just has no readable claims. Empty tokens are None: no passport is a valid, anonymous way to walk.

Source

pub fn from_env() -> Option<Self>

The traveler’s passport from INFINITE_PASSPORT (unset/empty → anonymous).

Source

pub fn token(&self) -> &str

The raw token, as presented on presence join / portal handoff.

Source

pub fn claims(&self) -> &Claims

Source

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

The stable identity, if the token’s claims were readable.

Source

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

Best display name: descriptor (freshest) → token claim → the sub itself.

Source

pub fn descriptor(&self) -> Option<&Descriptor>

The fetched descriptor, once Passport::poll has collected it.

Source

pub fn avatar_spec(&self) -> Option<&AvatarSpec>

The traveler’s own AvatarSpec (the shared avatar model), once the descriptor has landed and if the issuer provided one.

Source

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

Why the last descriptor fetch failed, if it did (e.g. 410 Gone after erasure — spec §6 — in which case the traveler renders anonymous).

Source

pub fn fetch_descriptor(&mut self)

Start fetching the descriptor from the token’s avatar claim on a background thread. No-op without a claim URL, while a fetch is in flight, or once loaded (the descriptor is session-cached; spec §3).

Source

pub fn poll(&mut self) -> bool

Collect a finished background fetch, if any. Call once per frame. Returns true on the frame the descriptor arrives.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more