Skip to main content

AuthEvent

Enum AuthEvent 

Source
pub enum AuthEvent {
    Provider {
        name: String,
        kind: ProviderKind,
        label: Option<String>,
    },
    LoginUrl {
        url: String,
        state: String,
    },
    Session {
        token: String,
        principal: String,
        agent: Option<String>,
        name: Option<String>,
        expires_at: i64,
        ceiling: Vec<String>,
    },
    Waiting {
        principal: String,
        name: Option<String>,
        provider: Option<String>,
        since: i64,
    },
    Whoami {
        principal: String,
        name: Option<String>,
        agent: Option<String>,
        memberships: Vec<MembershipEntry>,
        ceiling: Vec<String>,
    },
    LoggedOut {
        principal: String,
    },
    Requires {
        method: String,
        grant: String,
        target: Option<String>,
        roles: Vec<String>,
        public: bool,
    },
    Role {
        role: String,
        grants: Vec<String>,
        all: bool,
    },
    Granted {
        principal: String,
        role: String,
        scope: String,
    },
    Revoked {
        principal: String,
        scope: String,
        roles: Vec<String>,
    },
    Error {
        message: String,
        error_kind: Option<String>,
        grant: Option<String>,
        scope: Option<String>,
        roles: Option<Vec<String>>,
        held_on: Option<Vec<String>>,
    },
}
Expand description

Every event the auth activation sends ({"type": …}).

Variants§

§

Provider

providers: one way in.

Fields

§name: String
§

LoginUrl

login {browser} / signup: open this URL.

Fields

§state: String
§

Session

login: signed in.

Fields

§token: String
§principal: String
§expires_at: i64
§ceiling: Vec<String>
§

Waiting

signup (asking for access) / waiting (an admin’s list).

Fields

§principal: String
§provider: Option<String>
§since: i64
§

Whoami

whoami.

Fields

§principal: String
§memberships: Vec<MembershipEntry>
§ceiling: Vec<String>
§

LoggedOut

logout.

Fields

§principal: String
§

Requires

requires {method}: its grant, its target, the roles that list it.

Fields

§method: String
§grant: String
§target: Option<String>
§roles: Vec<String>
§public: bool
§

Role

roles / role_set: a role and its grants (all: every grant — admin).

Fields

§role: String
§grants: Vec<String>
§all: bool
§

Granted

grant.

Fields

§principal: String
§role: String
§scope: String
§

Revoked

revoke: the roles it removed there.

Fields

§principal: String
§scope: String
§roles: Vec<String>
§

Error

Anything refused or failed. A refusal (error_kind: "forbidden") carries AUTH-2’s fields.

Fields

§message: String
§error_kind: Option<String>
§held_on: Option<Vec<String>>

Trait Implementations§

Source§

impl Clone for AuthEvent

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 AuthEvent

Source§

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

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

impl<'de> Deserialize<'de> for AuthEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for AuthEvent

Source§

impl From<Session> for AuthEvent

Source§

fn from(s: Session) -> Self

Converts to this type from the input type.
Source§

impl From<Waiting> for AuthEvent

Source§

fn from(w: Waiting) -> Self

Converts to this type from the input type.
Source§

impl JsonSchema for AuthEvent

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for AuthEvent

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 Serialize for AuthEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AuthEvent

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,

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> 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<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