Skip to main content

SupplementDescriptor

Struct SupplementDescriptor 

Source
pub struct SupplementDescriptor {
    pub summary: &'static str,
    pub schema: Option<&'static str>,
    pub diagnostic_codes: &'static [&'static str],
    pub requires: &'static [&'static str],
}
Expand description

Self-reported metadata about what a supplement validates and declares — colocated in the same module as the parse_and_validate_*/validate() logic that actually produces diagnostic_codes, so a change to one is a scroll away from the other, not a separate hand-maintained copy in a different crate. etdl capabilities/etdl supplement list read this generically (ExtensionRegistry::list/lookup + descriptor()) instead of each caller hard-coding a per-supplement summary — see crate::performance’s descriptor() for the reference shape every built-in supplement follows.

Fields§

§summary: &'static str

One-line human summary of what this supplement validates/declares. Empty (the default) for an extension that doesn’t override EtdlExtension::descriptor — e.g. a dynamically loaded .wasm plugin, whose wire ABI (docs/reference/supplement-plugins.md) carries no description field to report here.

§schema: Option<&'static str>

The schema/version string this supplement’s x-* field is versioned against (e.g. "etdl.performance/1.0"), if it has one distinct from EtdlExtension::version().

§diagnostic_codes: &'static [&'static str]

Every diagnostic code this supplement’s own validation can produce.

§requires: &'static [&'static str]

Other supplement ids this one has a real dependency on, if any (e.g. etdl.security on etdl.tree-event — see crate::security’s module docs for what “dependency” means in practice here).

Trait Implementations§

Source§

impl Clone for SupplementDescriptor

Source§

fn clone(&self) -> SupplementDescriptor

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 Copy for SupplementDescriptor

Source§

impl Debug for SupplementDescriptor

Source§

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

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

impl Default for SupplementDescriptor

Source§

fn default() -> SupplementDescriptor

Returns the “default value” for a type. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.