Struct RecordingRef 

pub struct RecordingRef { /* private fields */ }

One entry of a SigMF collection’s core:streams array.

Identifies a recording by its base name (the metadata file name without the .sigmf-meta extension) and the SHA-512 hash of that metadata file, as a lowercase hexadecimal string.

Implementations

impl RecordingRef

pub fn new(name: &str, hash: &str) -> Self

Creates a reference to the recording name whose metadata file has SHA-512 digest hash.

Neither argument is validated. The reference has no extension fields and serializes as an object (not a legacy tuple).

Examples

use sigmf::recording::RecordingRef;

let reference = RecordingRef::new("example", "0123abcd");
assert_eq!(reference.get_name(), "example");
assert_eq!(reference.get_hash(), "0123abcd");

let json = serde_json::to_value(&reference).unwrap();
assert_eq!(json, serde_json::json!({"name": "example", "hash": "0123abcd"}));

pub fn get_name(&self) -> &str

Returns the recording’s base name (the name key).

pub fn get_hash(&self) -> &str

Returns the SHA-512 digest of the recording’s metadata file (the hash key).

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

Returns the extension fields preserved on this entry, i.e. every key other than name and hash.

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

Inserts or replaces an extension field on this entry.

Returns the previous value stored under key, if any. Note that a reference parsed from a legacy [name, hash] tuple is written back as a tuple by Collection::to_vec_preserving_stream_forms, which drops any extension fields added to it.

Errors

Returns crate::SigmfError::InvalidMetadata if key is name or hash; use RecordingRef::set_name or RecordingRef::set_hash instead.

pub fn set_name(&mut self, name: String)

Sets the recording’s base name (the name key).

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

Sets the SHA-512 digest of the recording’s metadata file (the hash key).

Trait Implementations

impl Clone for RecordingRef

fn clone(&self) -> RecordingRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordingRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecordingRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RecordingRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.