Struct ExtensionRegistry 

pub struct ExtensionRegistry { /* private fields */ }

The set of extensions, by namespace and version, an application supports.

Pass a registry to Metadata::validate_with_registry or Collection::validate_with_registry so declared extensions are treated as verified and their fields are checked against each extension’s SCOPE and FIELDS.

Example

use serde::{Deserialize, Serialize};
use sigmf::extensions::{ExtensionRegistry, ExtensionScope, SigmfExtension};

#[derive(Serialize, Deserialize)]
struct Lab {
    #[serde(rename = "lab:gain_db")]
    gain_db: f64,
}

impl SigmfExtension for Lab {
    const NAMESPACE: &'static str = "lab";
    const VERSION: &'static str = "1.0.0";
    const SCOPE: ExtensionScope = ExtensionScope::Global;
    const FIELDS: &'static [&'static str] = &["lab:gain_db"];
}

let mut registry = ExtensionRegistry::new();
registry.register::<Lab>()?;
assert!(registry.supports("lab", "1.0.0"));
assert!(!registry.supports("lab", "2.0.0"));
assert!(registry.supports_field("lab", "1.0.0", ExtensionScope::Global, "lab:gain_db"));
assert!(!registry.supports_scope("lab", "1.0.0", ExtensionScope::Capture));

// Registering the same namespace and version twice is an error.
assert!(registry.register::<Lab>().is_err());

Implementations

impl ExtensionRegistry

pub fn new() -> Self

Creates an empty registry.

pub fn register<T: SigmfExtension>(&mut self) -> Result<(), SigmfError>

Registers support for extension T at its namespace and version.

Errors

Returns SigmfError::InvalidMetadata if T’s namespace is empty or "core", its version is empty, or the same namespace and version are already registered.

pub fn supports(&self, namespace: &str, version: &str) -> bool

Returns true if the extension namespace at version is registered.

pub fn supports_scope( &self, namespace: &str, version: &str, scope: ExtensionScope, ) -> bool

Returns true if the registered extension namespace at version applies to scope.

Returns false if the extension is not registered.

pub fn supports_field( &self, namespace: &str, version: &str, scope: ExtensionScope, field: &str, ) -> bool

Returns true if the registered extension namespace at version applies to scope and defines the namespaced wire name field.

Returns false if the extension is not registered.

pub fn declarations(&self) -> Vec<ExtensionDeclaration>

Returns a core:extensions declaration for each registered extension.

Declarations are sorted by namespace, then version, and are all marked as required (optional: false).

Trait Implementations

impl Clone for ExtensionRegistry

fn clone(&self) -> ExtensionRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtensionRegistry

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

Formats the value using the given formatter.

impl Default for ExtensionRegistry

fn default() -> ExtensionRegistry

Returns the “default value” for a type.