Struct Global 

pub struct Global {

    pub version: String,
    pub datatype: Datatype,
    pub sample_rate: Option<Number>,
    pub author: Option<String>,
    pub collection: Option<String>,
    pub data_doi: Option<String>,
    pub description: Option<String>,
    pub hw: Option<String>,
    pub license: Option<String>,
    pub metadata_only: Option<bool>,
    pub meta_doi: Option<String>,
    pub num_channels: Option<Integer>,
    pub offset: Option<Integer>,
    pub recorder: Option<String>,
    pub sha512: Option<String>,
    pub geolocation: Option<GeoJson>,
    pub extensions: Option<Vec<ExtensionDeclaration>>,
    pub dataset: Option<String>,
    pub trailing_bytes: Option<Integer>,
    /* private fields */
}

The SigMF global object of a metadata file.

Required fields (core:version and core:datatype) are stored directly; optional core fields are stored as Options and are omitted from serialized JSON when None. Unknown keys encountered during deserialization (typically extension fields) are retained and serialized back out unchanged; see Global::extra_fields and Global::insert_extra.

Examples

use sigmf::global::{Datatype, Global};

let datatype: Datatype = "cf32_le".parse()?;
let mut global = Global::new("1.2.6", datatype);
global.set_sample_rate(1_000_000.0);
global.set_description("Example capture".to_string());

let json = serde_json::to_value(&global)?;
assert_eq!(json["core:version"], "1.2.6");
assert_eq!(json["core:datatype"], "cf32_le");
assert_eq!(json["core:sample_rate"], 1_000_000.0);
assert!(json.get("core:author").is_none());

Fields

version: String

Version of the SigMF specification the metadata conforms to (core:version).

datatype: Datatype

Format of the samples stored in the dataset file (core:datatype).

sample_rate: Option<Number>

Sample rate of the recording in samples per second (core:sample_rate).

author: Option<String>

Name and optionally email address of the recording’s author (core:author).

collection: Option<String>

Base filename of the SigMF collection this recording belongs to (core:collection).

data_doi: Option<String>

Digital Object Identifier (DOI) of the dataset file (core:data_doi).

description: Option<String>

Free-text description of the recording (core:description).

hw: Option<String>

Description of the hardware used to make the recording (core:hw).

license: Option<String>

URL of the license under which the recording is distributed (core:license).

metadata_only: Option<bool>

Whether the metadata is intentionally distributed without a dataset file (core:metadata_only).

Must not be used together with Non-Conforming Dataset fields.

meta_doi: Option<String>

Digital Object Identifier (DOI) of the metadata file (core:meta_doi).

num_channels: Option<Integer>

Number of interleaved channels in the dataset file (core:num_channels).

The SigMF specification treats an absent value as one channel.

offset: Option<Integer>

Index offset of the first sample in the dataset file (core:offset).

recorder: Option<String>

Name of the software used to make the recording (core:recorder).

sha512: Option<String>

Hex-encoded SHA-512 hash of the dataset file (core:sha512).

geolocation: Option<GeoJson>

GeoJSON location of the recording system (core:geolocation).

extensions: Option<Vec<ExtensionDeclaration>>

Extensions used by this recording’s metadata (core:extensions).

dataset: Option<String>

Full filename of a Non-Conforming Dataset file (core:dataset).

trailing_bytes: Option<Integer>

Number of bytes to ignore at the end of a Non-Conforming Dataset file (core:trailing_bytes).

Implementations

impl Global

pub fn new(version: impl Into<String>, datatype: Datatype) -> Self

Creates a Global with the required core:version and core:datatype fields set and every optional field unset.

No validation of version is performed here.

Examples

use sigmf::global::{ComponentType, Datatype, Endianness, Global, SampleDomain};

let datatype = Datatype::new(
    SampleDomain::Complex,
    Some(ComponentType::I16),
    Some(Endianness::LE),
    None,
)?;
let global = Global::new("1.2.6", datatype);
assert_eq!(global.get_version(), "1.2.6");
assert_eq!(global.get_datatype().as_str(), "ci16_le");
assert!(global.get_sample_rate().is_none());
assert!(global.extra_fields().is_empty());

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

Returns the fields of this object that are not modeled by a typed field, keyed by their full JSON key.

These are the keys that did not map to a typed field during deserialization (typically extension fields such as antenna:gain), plus any added via Global::insert_extra. They are serialized alongside the typed core fields.

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

Inserts or replaces an extra (non-typed) field, returning the previous value for key if one was present.

The key is stored as given; namespace syntax and extension declarations are not checked here (see crate::validation).

Errors

Returns SigmfError::InvalidMetadata if key is one of the core: global keys modeled by a typed field on Global (for example core:sample_rate); set those through the corresponding field or setter instead.

pub fn set_version(&mut self, version: String)

Sets the SigMF specification version (core:version).

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

Sets the sample format of the dataset (core:datatype).

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

Sets the sample rate in samples per second (core:sample_rate).

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

Sets the recording author (core:author).

pub fn set_collection(&mut self, collection_str: String)

Sets the base filename of the associated collection (core:collection).

pub fn set_data_doi(&mut self, data_doi: String)

Sets the DOI of the dataset file (core:data_doi).

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

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

pub fn set_hw(&mut self, hw: String)

Sets the hardware description (core:hw).

pub fn set_license(&mut self, license: String)

Sets the license URL (core:license).

pub fn set_metadata_only(&mut self, metadata_only: bool)

Sets whether the metadata is distributed without a dataset (core:metadata_only).

pub fn set_meta_doi(&mut self, meta_doi: String)

Sets the DOI of the metadata file (core:meta_doi).

pub fn set_num_channels(&mut self, num_channels: Integer)

Sets the number of interleaved channels (core:num_channels).

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

Sets the index offset of the first sample (core:offset).

pub fn set_recorder(&mut self, recorder: String)

Sets the name of the recording software (core:recorder).

pub fn set_sha512(&mut self, hash: String)

Sets the SHA-512 hash of the dataset file (core:sha512).

The value is stored as given; it is not computed or verified here.

pub fn set_geolocation(&mut self, geolocation: GeoJson)

Sets the GeoJSON location of the recording system (core:geolocation).

pub fn set_extensions(&mut self, extensions: Vec<ExtensionDeclaration>)

Replaces the list of declared extensions (core:extensions).

pub fn set_dataset(&mut self, dataset: String)

Sets the Non-Conforming Dataset filename (core:dataset).

pub fn set_trailing_bytes(&mut self, trailing_bytes: Integer)

Sets the number of trailing bytes to ignore in a Non-Conforming Dataset (core:trailing_bytes).

pub fn get_version(&self) -> String

Returns a copy of the SigMF specification version (core:version).

pub fn get_datatype(&self) -> Datatype

Returns a copy of the dataset sample format (core:datatype).

pub fn get_sample_rate(&self) -> Option<Number>

Returns the sample rate in samples per second (core:sample_rate), if set.

pub fn get_author(&self) -> Option<String>

Returns a copy of the recording author (core:author), if set.

pub fn get_collection(&self) -> Option<String>

Returns a copy of the associated collection’s base filename (core:collection), if set.

pub fn get_data_doi(&self) -> Option<String>

Returns a copy of the dataset DOI (core:data_doi), if set.

pub fn get_description(&self) -> Option<String>

Returns a copy of the free-text description (core:description), if set.

pub fn get_hw(&self) -> Option<String>

Returns a copy of the hardware description (core:hw), if set.

pub fn get_license(&self) -> Option<String>

Returns a copy of the license URL (core:license), if set.

pub fn get_metadata_only(&self) -> Option<bool>

Returns the metadata-only flag (core:metadata_only), if set.

pub fn get_meta_doi(&self) -> Option<String>

Returns a copy of the metadata DOI (core:meta_doi), if set.

pub fn get_num_channels(&self) -> Option<Integer>

Returns the number of interleaved channels (core:num_channels), if set.

This returns None when the key is absent; it does not apply the specification’s default of one channel.

pub fn get_offset(&self) -> Option<Integer>

Returns the index offset of the first sample (core:offset), if set.

pub fn get_recorder(&self) -> Option<String>

Returns a copy of the recording software name (core:recorder), if set.

pub fn get_sha512(&self) -> Option<String>

Returns a copy of the dataset SHA-512 hash (core:sha512), if set.

pub fn get_geolocation(&self) -> Option<GeoJson>

Returns a copy of the GeoJSON location (core:geolocation), if set.

pub fn get_extensions(&self) -> Option<Vec<ExtensionDeclaration>>

Returns a copy of the declared extensions (core:extensions), if set.

pub fn get_dataset(&self) -> Option<String>

Returns a copy of the Non-Conforming Dataset filename (core:dataset), if set.

pub fn get_trailing_bytes(&self) -> Option<Integer>

Returns the number of trailing bytes to ignore (core:trailing_bytes), if set.

Trait Implementations

impl Clone for Global

fn clone(&self) -> Global

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Global

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Global

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Global

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

where __S: Serializer,

Serialize this value into the given Serde serializer.