Struct Collection 

pub struct Collection {
    pub collection: CollectionMetadata,
    /* private fields */
}

A complete .sigmf-collection document.

Top-level fields other than collection are preserved in extra_fields.

Fields

collection: CollectionMetadata

The collection object.

Implementations

impl Collection

pub fn new(collection: CollectionMetadata) -> Self

Creates a collection document with no extra top-level fields.

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

Returns the preserved top-level fields other than collection.

pub fn from_slice(bytes: &[u8]) -> Result<Self, SigmfError>

Parses a collection document from JSON bytes.

Parsing is stricter than plain deserialization: duplicate object keys are rejected, core:version and core:streams are required, each stream must be a {"name", "hash"} object or a two-string legacy tuple, and optional core: fields may not be null.

Errors

Returns SigmfError::ResourceLimit if bytes exceeds the 1,000,000-byte metadata limit, SigmfError::InvalidJson if the input is not valid JSON or contains duplicate keys, and SigmfError::InvalidMetadata if it is not a well-formed collection.

pub fn to_vec(&self) -> Result<Vec<u8>, SigmfError>

Serializes the collection to compact JSON.

All stream references are written in object form.

Errors

Returns an error if serialization fails.

pub fn to_vec_preserving_stream_forms(&self) -> Result<Vec<u8>, SigmfError>

Serializes the collection to compact JSON, writing stream references that were read as legacy [name, hash] tuples back as tuples.

Any extra fields on such references are dropped in tuple form.

Errors

Returns an error if serialization fails.

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

Inserts or replaces a preserved top-level field.

Returns the previous value for key, if any.

Errors

Returns SigmfError::InvalidMetadata if key is "collection".

impl Collection

pub fn validate(&self, policy: ValidationPolicy) -> ValidationReport

Validates this collection against SigMF rules using policy.

Checks the collection version, that each stream’s recording name is a safe relative path and is unique, that each metadata digest is 128 hexadecimal characters, unknown core: fields, and extension declarations. Recording references are not resolved; see Archive::validate_collection_references.

The returned report’s policy is None.

pub fn validate_with_registry( &self, policy: ValidationPolicy, registry: &ExtensionRegistry, ) -> ValidationReport

Validates this collection, using registry to verify declared extensions.

Like validate, but extensions registered in registry are treated as verified and their fields in the collection object are checked for scope and field names.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Collection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Collection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.