Struct Dynamic Plugin Manifest

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

pub struct DynamicPluginManifest {
    pub manifest_version: u32,
    pub plugin: DynamicPluginManifestPlugin,
    pub compat: DynamicPluginManifestCompat,
    pub defaults: DynamicPluginManifestDefaults,
    pub capabilities: DynamicPluginManifestCapabilities,
    pub config_schema: Option<DynamicPluginManifestConfigSchema>,
    pub load: DynamicPluginManifestLoad,
    pub source: Option<DynamicPluginManifestSource>,
    pub integrity: Option<DynamicPluginManifestIntegrity>,
    pub description: Option<String>,
}

Authored relay-plugin.toml manifest.

Fields

manifest_version: u32

Relay plugin manifest schema version.

plugin: DynamicPluginManifestPlugin

Plugin identity and lane declaration.

compat: DynamicPluginManifestCompat

Relay compatibility declarations.

defaults: DynamicPluginManifestDefaults

Default desired-state settings.

capabilities: DynamicPluginManifestCapabilities

Required capability declarations.

config_schema: Option<DynamicPluginManifestConfigSchema>

Optional static configuration schema reference.

load: DynamicPluginManifestLoad

Runtime load contract.

source: Option<DynamicPluginManifestSource>

Optional source-oriented author metadata.

integrity: Option<DynamicPluginManifestIntegrity>

Optional integrity/authenticity evidence references.

description: Option<String>

Optional human-oriented description.

Implementations

impl DynamicPluginManifest

impl DynamicPluginManifest

parse_toml

pub fn parse_toml(toml_source: &str) -> Result<Self>

Parses a relay-plugin.toml manifest from TOML text.

load_from_path

pub fn load_from_path(path: impl AsRef<Path>) -> Result<(Self, String)>

Loads and validates a relay-plugin.toml manifest from a file path or directory.

validate

pub fn validate(&self) -> Result<()>

Validates the authored manifest against the v1 contract.

resolve_config_schema_path

pub fn resolve_config_schema_path(
    &self,
    canonical_manifest_path: impl AsRef<Path>,
) -> Result<Option<PathBuf>>

Resolves the declared configuration schema path without accessing it.

Relative schema paths are resolved from the parent directory of the canonical relay-plugin.toml path. Absolute local paths are returned unchanged.

into_record

pub fn into_record(
    self,
    manifest_ref: Option<String>,
) -> Result<DynamicPluginRecord>

Converts the authored manifest into a durable control-plane record.

validation_status

pub fn validation_status(&self) -> DynamicPluginValidationStatus

Produces the initial validation status for a successfully validated manifest.

Trait Implementations

impl Clone for DynamicPluginManifest

impl Clone for DynamicPluginManifest

clone

fn clone(&self) -> DynamicPluginManifest

clone_from

fn clone_from(&mut self, source: &Self)

impl Debug for DynamicPluginManifest

impl Debug for DynamicPluginManifest

fmt

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

impl<'de> Deserialize<'de> for DynamicPluginManifest

impl<'de> Deserialize<'de> for DynamicPluginManifest

deserialize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

impl PartialEq for DynamicPluginManifest

impl PartialEq for DynamicPluginManifest

eq

fn eq(&self, other: &DynamicPluginManifest) -> bool

ne

fn ne(&self, other: &Rhs) -> bool

impl Serialize for DynamicPluginManifest

impl Serialize for DynamicPluginManifest

serialize

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

impl Eq for DynamicPluginManifest

impl Eq for DynamicPluginManifest

impl StructuralPartialEq for DynamicPluginManifest

impl StructuralPartialEq for DynamicPluginManifest