Skip to main content

PluginSchema

Struct PluginSchema 

Source
pub struct PluginSchema {
Show 13 fields pub namespace: String, pub version: String, pub description: String, pub long_description: Option<String>, pub self_hash: String, pub children_hash: Option<String>, pub hash: String, pub methods: Vec<MethodSchema>, pub children: Option<Vec<ChildSummary>>, pub request: Option<Value>, pub deprecation: Option<DeprecationInfo>, pub roles: BTreeMap<String, Vec<String>>, pub view: Option<ViewKind>,
}
Expand description

A plugin’s schema with methods and child summaries.

Children are represented as summaries (namespace, description, hash) rather than full recursive schemas. This enables lazy traversal - clients can fetch child schemas individually via {namespace}.schema.

  • Leaf plugins have children = None
  • Hub plugins have children = Some([ChildSummary, ...])

Fields§

§namespace: String

The plugin’s namespace (e.g., “echo”, “plexus”)

§version: String

The plugin’s version (e.g., “1.0.0”)

§description: String

Short description of the plugin (max 15 words)

§long_description: Option<String>

Detailed description of the plugin (optional)

§self_hash: String

Hash of ONLY this plugin’s methods (ignores children): of each method’s hash, so it changes whenever any method’s schema changes

§children_hash: Option<String>

Hash of ONLY child plugin hashes (None for leaf plugins) Changes when any child’s hash changes (recursively)

§hash: String

Composite hash = hash(self_hash + children_hash) Use this if you want a single hash for the entire subtree

§methods: Vec<MethodSchema>

Methods exposed by this plugin

§children: Option<Vec<ChildSummary>>
👎Deprecated since 0.5:

Derive from MethodRole on MethodSchema. Field will be removed in 0.7.

Child plugin summaries (None = leaf plugin, Some = hub plugin)

§Deprecated (IR-4)

This side-table is deterministically derived from the method list’s MethodRole tags (one ChildSummary per non-Rpc method). It stays on the wire for back-compat during the 0.5 transition window and is slated for removal in 0.6.

Consumers reading child metadata should switch to iterating methods and filtering by role != MethodRole::Rpc. The name field on each MethodSchema is the child’s namespace.

§request: Option<Value>

JSON Schema for the HTTP request type this activation extracts from incoming connections.

Present when the activation declares request = MyRequest in #[plexus::activation(...)]. The schema includes x-plexus-source extension fields on each property describing where each field is sourced from (cookie, header, query param, peer address, etc.).

Clients can use this to understand what request data the activation expects and to generate appropriate authentication/context documentation.

§deprecation: Option<DeprecationInfo>

If set, this whole activation is deprecated.

Added in IR-5. Defaults to None via #[serde(default)] so pre-IR schemas deserialize cleanly.

Populated by the #[deprecated(...)] attribute on the impl Activation for Foo block (IR-5).

§roles: BTreeMap<String, Vec<String>>

AUTH-3: this activation’s default roles — role name → the grants it lists (<activation>.<method>, role inclusion already flattened), as declared by #[plexus_macros::activation(roles(...))]. admin is built in and never listed. Empty (and absent on the wire) when the activation declares none.

§view: Option<ViewKind>

AUTH-4: which view of a gated hub this schema answers from — anonymous (only the door: the public methods) or caller (the methods the caller holds). Absent from every schema a hub without a gate answers, so those stay byte-identical.

Implementations§

Source§

impl PluginSchema

Source

pub fn derive_legacy_fields( methods: &[MethodSchema], ) -> (Vec<ChildSummary>, bool)

Derive the deprecated (children, is_hub) side-table fields from a role-tagged method list.

Added in IR-4 as the centralized shim that backfills the pre-IR children: Option<Vec<ChildSummary>> and is_hub: bool representations from the authoritative MethodRole on each MethodSchema.

§Semantics

One ChildSummary is produced per non-Rpc method, preserving the source order. The shim writes:

FieldValue
namespaceThe method’s name.
descriptionThe method’s description.
hashEmpty string — the shim does not compute child hashes. Callers that want per-child hashes must populate them out-of-band.

The returned bool matches PluginSchema::is_hub_by_role — true iff at least one method carries a child role.

§Example
use plexus_core::plexus::schema::{MethodRole, MethodSchema, PluginSchema};

let methods = vec![
    MethodSchema::new("ping", "rpc", "h1"),
    MethodSchema::new("kid",  "static child", "h2")
        .with_role(MethodRole::StaticChild),
];
let (children, is_hub) = PluginSchema::derive_legacy_fields(&methods);
assert_eq!(children.len(), 1);
assert_eq!(children[0].namespace, "kid");
assert!(is_hub);
Source

pub fn leaf( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, methods: Vec<MethodSchema>, ) -> Self

Create a new leaf plugin schema (no children)

Source

pub fn leaf_with_long_description( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, long_description: impl Into<String>, methods: Vec<MethodSchema>, ) -> Self

Create a new leaf plugin schema with long description

Source

pub fn hub( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, methods: Vec<MethodSchema>, children: Vec<ChildSummary>, ) -> Self

Create a new hub plugin schema (with child summaries)

Source

pub fn hub_with_long_description( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, long_description: impl Into<String>, methods: Vec<MethodSchema>, children: Vec<ChildSummary>, ) -> Self

Create a new hub plugin schema with long description

Source

pub fn is_hub(&self) -> bool

👎Deprecated since 0.5:

Use PluginSchema::is_hub_by_role() which reads MethodRole from methods. This method will be removed in 0.7.

Check if this is a hub.

Returns true iff the plugin exposes child activations. As of IR-2, this is derived from either source of truth:

  1. Any method tagged with a child MethodRole (StaticChild or DynamicChild { .. }). This is the post-IR-3 authoritative signal.
  2. The legacy children: Option<Vec<ChildSummary>> field is Some. Preserved for back-compat during the IR transition window — today’s macros populate children but not yet role.
§Deprecated (IR-4)

The legacy transition-window fallback on children.is_some() is redundant now that MethodRole tags are authoritative. Callers should migrate to PluginSchema::is_hub_by_role, which reads only role-tagged methods. This method will be removed in 0.7.

Source

pub fn is_hub_by_role(&self) -> bool

Returns true iff any method carries a child MethodRole.

This is the derived query specified by IR-2: it reads only self.methods, ignoring the legacy children side channel. Use this when you want the post-IR-3 authoritative answer without the transition fallback that is_hub() provides.

Source

pub fn is_leaf(&self) -> bool

Check if this is a leaf (no children)

Source

pub fn with_deprecation(self, info: DeprecationInfo) -> Self

Mark this plugin as deprecated.

Added in IR-5. Populates the deprecation field with the provided DeprecationInfo. Populated by the #[deprecated(...)] attribute on an impl Activation for Foo block via plexus-macros.

Source

pub fn fill_site_hints(&mut self, site: &AttachmentSite)

CA-1: fill site_hint on every method’s requires_credential that lacks one, using the hub-derived attach site. Applied at schema-assembly time by DynamicHub when the backend’s advertised auth capabilities imply a site — service authors write nothing.

RETURNS-10: filled after the hashes are computed, so the hints are not covered by them — they come from the serving service’s configuration, not the activation’s code, and re-hashing on every schema response is the per-call cost the hashes are cached to avoid.

Trait Implementations§

Source§

impl Clone for PluginSchema

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 PluginSchema

Source§

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

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

impl<'de> Deserialize<'de> for PluginSchema

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 PluginSchema

Source§

impl JsonSchema for PluginSchema

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 PluginSchema

NEST-5: a schema compares by what it serializes to — so a role carrying one (DynamicChild { child }) keeps PartialEq/Eq.

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 PluginSchema

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

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