Struct CollectionMetadata 

pub struct CollectionMetadata {
    pub version: String,
    pub description: Option<String>,
    pub author: Option<String>,
    pub collection_doi: Option<String>,
    pub license: Option<String>,
    pub extensions: Option<Vec<ExtensionDeclaration>>,
    pub streams: Vec<RecordingRef>,
    /* private fields */
}

The collection object of a .sigmf-collection document.

Fields not modeled here, such as extension fields, are preserved in extra_fields. Typed extension access is available through extension and related methods.

Fields

version: String

core:version: the SigMF version of the collection (required).

description: Option<String>

core:description: a text description of the collection.

author: Option<String>

core:author: the author’s name and optionally email address.

collection_doi: Option<String>

core:collection_doi: the registered DOI for the collection.

license: Option<String>

core:license: a URL for the license under which the collection is offered.

extensions: Option<Vec<ExtensionDeclaration>>

core:extensions: the extensions used by the collection.

streams: Vec<RecordingRef>

core:streams: references to the recordings in the collection (required).

Both the object form and the legacy [name, hash] tuple form are accepted when deserializing; references are serialized as objects.

Implementations

impl CollectionMetadata

pub fn new(version: impl Into<String>, streams: Vec<RecordingRef>) -> Self

Creates a collection object with the given version and stream references and no optional fields.

Example

use sigmf::collection::CollectionMetadata;
use sigmf::recording::RecordingRef;

let hash = "ab".repeat(64);
let mut metadata = CollectionMetadata::new(
    "1.2.6",
    vec![RecordingRef::new("rx0", &hash), RecordingRef::new("rx1", &hash)],
);
metadata.author = Some("Jane Doe <jane@example.com>".into());
assert_eq!(metadata.streams.len(), 2);
assert!(metadata.extensions.is_none());

pub fn extra_fields(&self) -> &Map<String, Value>

Returns the preserved fields not modeled by this struct, such as extension fields.

pub fn insert_extra( &mut self, key: impl Into<String>, value: Value, ) -> Result<Option<Value>, SigmfError>

Inserts or replaces a preserved field, such as an extension field.

Returns the previous value for key, if any.

Errors

Returns SigmfError::InvalidMetadata if key names a field modeled by this struct (e.g. core:version or core:streams).

impl CollectionMetadata

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

Reads extension T from this collection object’s fields.

Only the keys listed in SigmfExtension::FIELDS are considered; absent keys are simply omitted before deserialization.

Errors

Returns SigmfError::InvalidMetadata if T’s scope is not ExtensionScope::Collection or the fields do not deserialize into T.

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

Writes extension T into this collection object.

All of T’s declared FIELDS are first removed, then the serialized fields are inserted, so fields omitted by serialization are cleared. core:extensions is not modified.

Errors

Returns SigmfError::InvalidMetadata if T’s scope is not ExtensionScope::Collection, extension does not serialize to a JSON object, or it serializes a key not listed in FIELDS; returns SigmfError::Serde if serialization fails. Nothing is changed on error.

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

Removes all of extension T’s declared fields from this collection object.

Errors

Returns SigmfError::InvalidMetadata if T’s scope is not ExtensionScope::Collection.

Trait Implementations

impl Clone for CollectionMetadata

fn clone(&self) -> CollectionMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CollectionMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.