Skip to main content

AuthActivation

Struct AuthActivation 

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

The auth activation. Mounted by DynamicHub::with_auth; see the module docs.

Implementations§

Source§

impl AuthActivation

Source

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

Source

pub const PLUGIN_ID: Uuid

Stable plugin instance ID for handle routing

Source

pub fn plugin_id(&self) -> Uuid

Get the plugin’s stable instance ID

Trait Implementations§

Source§

impl Activation for AuthActivation

Source§

type Methods = AuthActivationMethod

Source§

fn namespace(&self) -> &str

Source§

fn version(&self) -> &str

Source§

fn description(&self) -> &str

Short description (max 15 words)
Source§

fn long_description(&self) -> Option<&str>

Long description (optional, for detailed documentation)
Source§

fn methods(&self) -> Vec<&str>

Source§

fn method_help(&self, method: &str) -> Option<String>

Source§

fn call<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, method: &'life1 str, params: Value, auth: Option<&'life2 AuthContext>, raw_ctx: Option<&'life3 RawRequestContext>, ) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Source§

fn into_rpc_methods(self) -> Methods

Source§

fn plugin_schema(&self) -> PluginSchema

Return this activation’s schema (methods + optional children)
Source§

fn slot_schema() -> Option<PluginSchema>
where Self: Sized,

NEST-5: this activation’s schema without an instance — what a parent’s dynamic #[child] publishes as its slot’s type (MethodRole::DynamicChild { child }). None (the default) for an activation the macro did not write; #[plexus_macros::activation] emits it (its static namespace, version, description, methods and roles).
Source§

fn plugin_id(&self) -> Uuid

Stable activation instance ID for handle routing By default generates a deterministic UUID from namespace+major_version Using major version only ensures handles survive minor/patch upgrades (semver)
Source§

fn resolve_handle<'life0, 'life1, 'async_trait>( &'life0 self, _handle: &'life1 Handle, ) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn static_child_schemas(&self) -> Vec<(String, PluginSchema)>

MACRO-20: this activation’s static children and theirs, as (path, schema) — the same list as ChildRouter::router_static_child_schemas, reachable from the hub’s type-erased registry (which holds Activations). Read more
Source§

fn needs(&self) -> Option<Vec<Need>>

NEST-16: what this activation calls of the service it is grafted onto — its schema’s needs, answered without building the schema (#[plexus_macros::activation(parent = …)] emits it). None: it declares nothing.
Source§

impl AuthActivationRpcServer for AuthActivation

Source§

fn providers<'life0, 'async_trait>( &'life0 self, pending: PendingSubscriptionSink, ) -> Pin<Box<dyn Future<Output = SubscriptionResult> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The ways in this server offers
Source§

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.
Source§

impl AuthActivationSchema for AuthActivation
where for<'__plexus_schema> AuthActivation: Clone,

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 ChildRouter for AuthActivation

Source§

fn router_namespace(&self) -> &str

Get the namespace of this router (for error messages)
Source§

fn router_call<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, method: &'life1 str, params: Value, auth: Option<&'life2 AuthContext>, raw_ctx: Option<&'life3 RawRequestContext>, ) -> Pin<Box<dyn Future<Output = Result<PlexusStream, PlexusError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Call a method on this router
Source§

fn get_child<'life0, 'life1, 'async_trait>( &'life0 self, _name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Option<Box<dyn ChildRouter>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a child activation instance by name for nested routing
Source§

fn capabilities(&self) -> ChildCapabilities

Which optional operations (list / search) this router supports. Read more
Source§

fn router_schema(&self) -> Option<PluginSchema>

MACRO-20: this router’s own schema, when it has one. Read more
Source§

fn peer_child<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn ChildRouter>>, PeerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

NEST-7: the child or peer named name, or why a peer could not be returned — what routing asks, so a caller gets a typed error item (not_grafted, unavailable, shape_mismatch, …), never “not found”, for a peer that failed. Default: Self::get_child, which cannot fail. #[plexus_macros::activation] overrides it for an activation with a #[plexus_macros::peer] slot.
Source§

fn list_children<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stream every child name the router is willing to enumerate. Read more
Source§

fn search_children<'life0, 'life1, 'async_trait>( &'life0 self, _query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Option<BoxStream<'_, String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stream child names matching the router-defined query semantics. Read more
Source§

fn forward_policy_for(&self, _callee_ns: &str) -> Option<Arc<dyn ForwardPolicy>>

Look up the forward policy declared for a callee namespace. Read more
Source§

fn router_static_child_schemas(&self) -> Vec<(String, PluginSchema)>

MACRO-20: every static child below this router that describes itself, as (path, schema) — path relative to this router, dotted for a grandchild ("commits", "commits.audit"), schema the child’s own (its methods’ grants and its roles relative to it, as its macro wrote them). Read more
Source§

fn framework_stamped_principal(&self) -> Principal

Framework-stamped immediate-caller plexus_auth_core::Principal of this router. Read more
Source§

impl Clone for AuthActivation

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 HasClient for AuthActivation

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> 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> Peer for T

Source§

fn interface(&self) -> Interface

The shape this peer serves.
Source§

fn call<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, method: &'life1 str, params: Value, auth: Option<&'life2 AuthContext>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = PlexusStreamItem> + Send>>, PlexusError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

Call one of its methods (repos, or a path below it: child.m).
Source§

fn peer<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Peer>, PeerError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,

The primitive, one level down: this peer’s own peers by name.
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