pub struct AuthActivation { /* private fields */ }Expand description
The auth activation. Mounted by
DynamicHub::with_auth; see the module
docs.
Implementations§
Trait Implementations§
Source§impl Activation for AuthActivation
impl Activation for AuthActivation
type Methods = AuthActivationMethod
fn namespace(&self) -> &str
fn version(&self) -> &str
Source§fn description(&self) -> &str
fn description(&self) -> &str
Short description (max 15 words)
Source§fn long_description(&self) -> Option<&str>
fn long_description(&self) -> Option<&str>
Long description (optional, for detailed documentation)
fn methods(&self) -> Vec<&str>
fn method_help(&self, method: &str) -> Option<String>
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,
fn into_rpc_methods(self) -> Methods
Source§fn plugin_schema(&self) -> PluginSchema
fn plugin_schema(&self) -> PluginSchema
Return this activation’s schema (methods + optional children)
Source§fn slot_schema() -> Option<PluginSchema>where
Self: Sized,
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
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)
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)>
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 moreSource§impl AuthActivationRpcServer for AuthActivation
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,
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§impl AuthActivationSchema for AuthActivationwhere
for<'__plexus_schema> AuthActivation: Clone,
impl AuthActivationSchema for AuthActivationwhere
for<'__plexus_schema> AuthActivation: Clone,
Source§fn login(&self, flow: LoginFlow) -> BoxStream<'static, AuthEvent>
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>
fn signup(&self, via: Option<ProviderName>) -> BoxStream<'static, AuthEvent>
Create an account, or ask for access
Source§fn whoami(&self) -> BoxStream<'static, AuthEvent>
fn whoami(&self) -> BoxStream<'static, AuthEvent>
Who you are: principal, roles held where, ceiling
Source§fn requires(&self, method: MethodPath) -> BoxStream<'static, AuthEvent>
fn requires(&self, method: MethodPath) -> BoxStream<'static, AuthEvent>
What a method needs: its grant, target, and the roles that list it
Source§fn role_set(
&self,
role: RoleName,
grants: Vec<GrantName>,
) -> BoxStream<'static, AuthEvent>
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>
fn grant( &self, principal: Principal, role: RoleName, scope: ScopeName, ) -> BoxStream<'static, AuthEvent>
Give a principal a role on a scope
Source§impl ChildRouter for AuthActivation
impl ChildRouter for AuthActivation
Source§fn router_namespace(&self) -> &str
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,
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,
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
fn capabilities(&self) -> ChildCapabilities
Which optional operations (list / search) this router supports. Read more
Source§fn router_schema(&self) -> Option<PluginSchema>
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,
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,
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,
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>>
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)>
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 moreSource§fn framework_stamped_principal(&self) -> Principal
fn framework_stamped_principal(&self) -> Principal
Framework-stamped immediate-caller
plexus_auth_core::Principal of
this router. Read moreSource§impl Clone for AuthActivation
impl Clone for AuthActivation
impl HasClient for AuthActivation
Auto Trait Implementations§
impl !RefUnwindSafe for AuthActivation
impl !UnwindSafe for AuthActivation
impl Forget for AuthActivation
impl Freeze for AuthActivation
impl Move for AuthActivation
impl Send for AuthActivation
impl Sync for AuthActivation
impl Unpin for AuthActivation
impl UnsafeUnpin for AuthActivation
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
Source§impl<T> Peer for Twhere
T: Activation + ChildRouter,
impl<T> Peer for Twhere
T: Activation + ChildRouter,
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,
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).