Struct MetadataEdit 

pub struct MetadataEdit<'a> { /* private fields */ }

A transactional edit of a Metadata document, created by Metadata::edit.

Edits are applied to a draft. To publish them, call MetadataEdit::validate and then MetadataEdit::commit; any change made after validating invalidates the report, so commit always applies exactly the draft that was validated. Dropping the edit discards the draft.

Examples

use sigmf::meta::Metadata;
use sigmf::validation::ValidationPolicy;

let mut metadata = Metadata::from_slice(br#"{
    "global": {"core:version": "1.2.6", "core:datatype": "ri16_le"},
    "captures": [],
    "annotations": []
}"#)?;

let mut edit = metadata.edit();
edit.set_description("reviewed".to_string());
edit.validate(ValidationPolicy::StrictSupportedVersion);
edit.commit()?;

assert_eq!(metadata.get_description().as_deref(), Some("reviewed"));

Implementations

impl MetadataEdit<'_>

pub fn metadata(&self) -> &Metadata

Returns the current draft.

pub fn metadata_mut(&mut self) -> &mut Metadata

Returns mutable access to the draft for edits not covered by the convenience methods.

Discards any validation report, so MetadataEdit::validate must be called again before committing.

pub fn set_description(&mut self, description: String)

Sets the draft’s global core:description field and discards any validation report.

pub fn set_datatype(&mut self, datatype: Datatype)

Sets the draft’s global core:datatype field and discards any validation report.

pub fn set_offset(&mut self, offset: Integer)

Sets the draft’s global core:offset field and discards any validation report.

pub fn add_annotation(&mut self, annotation: Annotation)

Appends an annotation to the draft and discards any validation report.

pub fn replace_annotation( &mut self, index: usize, annotation: Annotation, ) -> Option<Annotation>

Replaces the draft annotation at index, returning the old one.

Returns None and leaves the draft (and any validation report) unchanged if index is out of bounds.

pub fn add_capture(&mut self, capture: Capture)

Appends a capture to the draft and discards any validation report.

pub fn replace_capture( &mut self, index: usize, capture: Capture, ) -> Option<Capture>

Replaces the draft capture at index, returning the old one.

Returns None and leaves the draft (and any validation report) unchanged if index is out of bounds.

pub fn remove_annotation(&mut self, index: usize) -> Option<Annotation>

Removes and returns the draft annotation at index, shifting later annotations down.

Returns None and leaves the draft (and any validation report) unchanged if index is out of bounds.

pub fn remove_capture(&mut self, index: usize) -> Option<Capture>

Removes and returns the draft capture at index, shifting later captures down.

Returns None and leaves the draft (and any validation report) unchanged if index is out of bounds.

pub fn stable_sort_segments(&mut self)

Stably sorts the draft’s captures and annotations by core:sample_start, as SigMF requires, and discards any validation report.

Entries with equal core:sample_start keep their relative order.

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

Validates the draft under policy and records the report for MetadataEdit::commit.

The returned report is stamped with the policy and a fingerprint of the draft, so it becomes stale if the draft changes afterwards. See Metadata::validate for the checks performed.

pub fn commit(self) -> Result<(), SigmfError>

Applies the draft to the original Metadata, consuming the edit.

Errors

Returns crate::SigmfError::InvalidMetadata, leaving the original document unchanged, if:

• MetadataEdit::validate has not been called since the last change;
• the recorded report has status Failed; or
• the draft no longer matches the fingerprint in the report.