Skip to main content

AuthClient

Struct AuthClient 

Source
pub struct AuthClient<T, L = Root> { /* private fields */ }
Expand description

Typed client for the auth activation, generated by #[plexus_macros::activation(client)].

Generic over the transport: construct it with any plexus_client::Transport — in-process for tests, WebSocket JSON-RPC or REST + SSE against a server.

A one-item method is an async fn returning Result<item, ClientError>; a many-item method returns a MethodStream. The parameter and item types are the activation’s own, so a change to either is a compile error here, not a runtime surprise.

Implementations§

Source§

impl<T> AuthClient<T>

Source

pub const NAMESPACE: &'static str = "auth"

The activation namespace this client speaks to.

Source

pub fn new(transport: T) -> Self

Wrap a transport.

Source

pub fn at(transport: T, path: impl Into<RoutePath>) -> Self

Wrap a transport, for this activation mounted at path — the dotted route from the service, e.g. "tickets.inputs" for a #[child]. new is at(transport, NAMESPACE). Its events are this activation’s own aggregate; a parent’s child accessor builds one whose events are the parent’s.

Source§

impl<T, L> AuthClient<T, L>

Source

pub fn lifted(transport: T, route: Route, lift: L) -> Self

RETURNS-46: a client on route whose calls’ .events() are lifted by lift — what a parent’s child accessor builds (TreeClient::branch() lifts into TreeEvent).

Source

pub fn path(&self) -> &str

The dotted path this client’s calls go to: the namespace, or the child path it was built at.

Source

pub fn transport(&self) -> &T

Borrow the underlying transport — for reading a MemoryTransport‘s recorded calls, or sharing one transport across several activations’ clients.

Source

pub fn into_transport(self) -> T

Unwrap the transport.

Source§

impl<T: Transport> AuthClient<T>

Source

pub const METHOD_PROVIDERS: MethodRef

The ways in this server offers

Calls auth.providers.

Source

pub const METHOD_LOGIN: MethodRef

Sign in — a person through the browser, an agent with its key

Calls auth.login.

Source

pub const METHOD_SIGNUP: MethodRef

Create an account, or ask for access

Calls auth.signup.

Source

pub const METHOD_WHOAMI: MethodRef

Who you are: principal, roles held where, ceiling

Calls auth.whoami.

Source

pub const METHOD_LOGOUT: MethodRef

Sign out: end this session

Calls auth.logout.

Source

pub const METHOD_REQUIRES: MethodRef

What a method needs: its grant, target, and the roles that list it

Calls auth.requires.

Source

pub const METHOD_ROLES: MethodRef

Every role and the grants it lists

Calls auth.roles.

Source

pub const METHOD_ROLE_SET: MethodRef

Set a role’s grants (admin on *)

Calls auth.role_set.

Source

pub const METHOD_GRANT: MethodRef

Give a principal a role on a scope

Calls auth.grant.

Source

pub const METHOD_REVOKE: MethodRef

Take a principal’s role on a scope away

Calls auth.revoke.

Source

pub const METHOD_WAITING: MethodRef

Who asked for access and holds nothing yet (admin on *)

Calls auth.waiting.

Source§

impl<T: Transport, L: Lift<AuthAggregate>> AuthClient<T, L>

Source

pub fn providers(&self) -> AuthProvidersStream<'_, L>

The ways in this server offers

Calls auth.providers.

Many items, as a stream of Result<item, ClientError> — a AuthProvidersStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Providers — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn login(&self, flow: LoginFlow) -> AuthLoginStream<'_, L>

Sign in — a person through the browser, an agent with its key

Calls auth.login.

Many items, as a stream of Result<item, ClientError> — a AuthLoginStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Login — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn signup(&self, via: Option<ProviderName>) -> AuthSignupStream<'_, L>

Create an account, or ask for access

Calls auth.signup.

Many items, as a stream of Result<item, ClientError> — a AuthSignupStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Signup — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn whoami(&self) -> AuthWhoamiStream<'_, L>

Who you are: principal, roles held where, ceiling

Calls auth.whoami.

Many items, as a stream of Result<item, ClientError> — a AuthWhoamiStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Whoami — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn logout(&self) -> AuthLogoutStream<'_, L>

Sign out: end this session

Calls auth.logout.

Many items, as a stream of Result<item, ClientError> — a AuthLogoutStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Logout — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn requires(&self, method: MethodPath) -> AuthRequiresStream<'_, L>

What a method needs: its grant, target, and the roles that list it

Calls auth.requires.

Many items, as a stream of Result<item, ClientError> — a AuthRequiresStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Requires — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn roles(&self) -> AuthRolesStream<'_, L>

Every role and the grants it lists

Calls auth.roles.

Many items, as a stream of Result<item, ClientError> — a AuthRolesStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Roles — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn role_set( &self, role: RoleName, grants: Vec<GrantName>, ) -> AuthRoleSetStream<'_, L>

Set a role’s grants (admin on *)

Calls auth.role_set.

Many items, as a stream of Result<item, ClientError> — a AuthRoleSetStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::RoleSet — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn grant( &self, principal: Principal, role: RoleName, scope: ScopeName, ) -> AuthGrantStream<'_, L>

Give a principal a role on a scope

Calls auth.grant.

Many items, as a stream of Result<item, ClientError> — a AuthGrantStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Grant — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn revoke( &self, principal: Principal, role: Option<RoleName>, scope: ScopeName, ) -> AuthRevokeStream<'_, L>

Take a principal’s role on a scope away

Calls auth.revoke.

Many items, as a stream of Result<item, ClientError> — a AuthRevokeStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Revoke — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn waiting(&self) -> AuthWaitingStream<'_, L>

Who asked for access and holds nothing yet (admin on *)

Calls auth.waiting.

Many items, as a stream of Result<item, ClientError> — a AuthWaitingStream; progress is dropped unless opted in with .with_progress(), and .events() yields AuthAggregate::Waiting — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Trait Implementations§

Source§

impl<T, L> Aggregated for AuthClient<T, L>

Source§

type Event = AuthAggregate

The activation’s own aggregate.
Source§

impl<T> Auth for AuthClient<T>
where T: Transport + Clone + Send + Sync + 'static,

Source§

fn providers(&self) -> BoxStream<'static, AuthEvent>

The ways in this server offers
Source§

fn login(&self, flow: LoginFlow) -> BoxStream<'static, AuthEvent>

Sign in — a person through the browser, an agent with its key
Source§

fn signup(&self, via: Option<ProviderName>) -> BoxStream<'static, AuthEvent>

Create an account, or ask for access
Source§

fn whoami(&self) -> BoxStream<'static, AuthEvent>

Who you are: principal, roles held where, ceiling
Source§

fn logout(&self) -> BoxStream<'static, AuthEvent>

Sign out: end this session
Source§

fn requires(&self, method: MethodPath) -> BoxStream<'static, AuthEvent>

What a method needs: its grant, target, and the roles that list it
Source§

fn roles(&self) -> BoxStream<'static, AuthEvent>

Every role and the grants it lists
Source§

fn role_set( &self, role: RoleName, grants: Vec<GrantName>, ) -> BoxStream<'static, AuthEvent>

Set a role’s grants (admin on *)
Source§

fn grant( &self, principal: Principal, role: RoleName, scope: ScopeName, ) -> BoxStream<'static, AuthEvent>

Give a principal a role on a scope
Source§

fn revoke( &self, principal: Principal, role: Option<RoleName>, scope: ScopeName, ) -> BoxStream<'static, AuthEvent>

Take a principal’s role on a scope away
Source§

fn waiting(&self) -> BoxStream<'static, AuthEvent>

Who asked for access and holds nothing yet (admin on *)
Source§

impl<T: Clone, L: Clone> Clone for AuthClient<T, L>

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<T: Debug, L> Debug for AuthClient<T, L>

Source§

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

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

impl<T: Default> Default for AuthClient<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T, L> Freeze for AuthClient<T, L>
where T: Freeze, L: Freeze,

§

impl<T, L> RefUnwindSafe for AuthClient<T, L>

§

impl<T, L> Send for AuthClient<T, L>
where T: Send, L: Send,

§

impl<T, L> Sync for AuthClient<T, L>
where T: Sync, L: Sync,

§

impl<T, L> Unpin for AuthClient<T, L>
where T: Unpin, L: Unpin,

§

impl<T, L> UnsafeUnpin for AuthClient<T, L>
where T: UnsafeUnpin, L: UnsafeUnpin,

§

impl<T, L> UnwindSafe for AuthClient<T, L>
where T: UnwindSafe, L: UnwindSafe,

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