Struct maia_httpd::sigmf::Metadata

pub struct Metadata { /* private fields */ }

SigMF metadata.

This structure can be used to create and edit SigMF metadata, and convert it to JSON format for its storage in a .sigmf-meta file.

Examples

use maia_httpd::sigmf::{Datatype, Field, Metadata, SampleFormat};
let datatype = Datatype { field: Field::Complex, format: SampleFormat::I8 };
let sample_rate = 1e6; // 1 Msps
let frequency = 100e6; // 100 MHz
let metadata = Metadata::new(datatype, sample_rate, frequency);
println!("{}", metadata.to_json());

Implementations

impl Metadata

pub fn new(datatype: Datatype, sample_rate: f64, frequency: f64) -> Metadata

Creates a new SigMF metadata object.

The datatype, sample rate and frequency are mandatory parameters. The datetime field is set to the current time. The description and author fields are initialized to empty strings.

pub fn datatype(&self) -> Datatype

Gives the value of the datatype field.

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

Sets the value datatype field.

pub fn sample_rate(&self) -> f64

Gives the value of the sample rate field (in samples per second).

pub fn set_sample_rate(&mut self, sample_rate: f64)

Sets the value of the sample rate field.

pub fn description(&self) -> &str

Gives the value of the description field.

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

Sets the value of the description field.

pub fn author(&self) -> &str

Gives the value of the author field.

pub fn set_author(&mut self, author: &str)

Sets the value of the author field.

pub fn frequency(&self) -> f64

Gives the value of the frequency field (in Hz).

pub fn set_frequency(&mut self, frequency: f64)

Sets the value of the frequency field.

pub fn datetime(&self) -> DateTime<Utc>

Gives the value of the datetime field.

pub fn set_datetime(&mut self, datetime: DateTime<Utc>)

Sets the value of the datetime field.

pub fn set_datetime_now(&mut self)

Sets the datetime field to the current time.

pub fn to_json(&self) -> String

Returns a string that represents the metadata in JSON.

The formatting of the JSON is compliant with the SigMF standard.

pub fn to_json_value(&self) -> Value

Returns a JSON serde_json::Value that represents the metadata in JSON.

The formatting of the JSON is compliant with the SigMF standard.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Metadata