Struct AnnotationBuilder 

pub struct AnnotationBuilder { /* private fields */ }

Builder for Annotation that validates frequency bounds on build.

Create one with Annotation::builder or AnnotationBuilder::new. All fields other than core:sample_start start unset. The built annotation has no extra fields.

Implementations

impl AnnotationBuilder

pub fn new(sample_start: Integer) -> Self

Creates a builder for an annotation beginning at sample_start (core:sample_start), with all other fields unset.

pub fn sample_count(self, sample_count: Integer) -> Self

Sets the number of annotated samples (core:sample_count).

Zero is accepted.

pub fn frequency_range(self, lower: Number, upper: Number) -> Self

Sets the lower and upper frequency edges in Hz (core:freq_lower_edge and core:freq_upper_edge).

The bounds are validated by build.

pub fn label(self, label: impl Into<String>) -> Self

Sets the short human-readable label (core:label).

pub fn comment(self, comment: impl Into<String>) -> Self

Sets the free-text comment (core:comment).

pub fn generator(self, generator: impl Into<String>) -> Self

Sets the name of the annotation’s creator (core:generator).

pub fn uuid(self, uuid: impl Into<String>) -> Self

Sets the annotation UUID (core:uuid).

The value is not checked to be a valid UUID.

pub fn build(self) -> Result<Annotation, SigmfError>

Validates the frequency bounds and builds the Annotation.

Errors

Returns crate::SigmfError::InvalidMetadata if frequency bounds were supplied and either bound is not finite, or the lower bound exceeds the upper bound.

Trait Implementations

impl Clone for AnnotationBuilder

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 AnnotationBuilder

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

Formats the value using the given formatter.