Skip to main content

LinkedCredential

Struct LinkedCredential 

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

One credential, bound to the principal it authenticates.

Implementations§

Source§

impl LinkedCredential

Source

pub fn new( class: CredentialClass, locator: impl Into<String>, principal: Principal, ) -> Self

Bind locator (a non-secret handle) to principal.

Source

pub fn with_roles(self, roles: Vec<String>) -> Self

Roles this credential asserts.

Source

pub fn with_claims(self, claims: Value) -> Self

Extra claims (org_id, username, …) this credential carries.

Source

pub fn expiring_at(self, at: DateTime<Utc>) -> Self

Give the credential a validity window.

Source

pub fn revoked(self) -> Self

Mark the credential withdrawn.

Source

pub fn created_at(self, at: DateTime<Utc>) -> Self

Override the creation timestamp (for stores reading rows back).

Source

pub fn class(&self) -> &CredentialClass

The credential’s class.

Source

pub fn locator(&self) -> &str

The non-secret handle this credential is found by.

Source

pub fn principal(&self) -> &Principal

The principal this credential authenticates.

Source

pub fn roles(&self) -> &[String]

Roles asserted by this credential.

Source

pub fn claims(&self) -> &Value

Claims carried by this credential.

Source

pub fn is_revoked(&self) -> bool

Has this credential been withdrawn?

Source

pub fn expires_at(&self) -> Option<DateTime<Utc>>

When it stops being valid, if ever.

Source

pub fn created(&self) -> DateTime<Utc>

When it was linked.

Source

pub fn is_expired_at(&self, now: DateTime<Utc>) -> bool

Is this credential past its validity window at now?

A credential with no expires_at never expires — that is today’s behavior for API keys with a null expires_at column and is preserved deliberately.

Trait Implementations§

Source§

impl Clone for LinkedCredential

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinkedCredential

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LinkedCredential

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LinkedCredential

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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