Struct mseed::MSRecord

pub struct MSRecord(/* private fields */);

miniSEED record structure.

Implementations

impl MSRecord

pub fn parse(buf: &[u8], flags: MSControlFlags) -> MSResult<Self>

Parses a MSRecord from a slice of bytes.

pub unsafe fn from_raw(ptr: *mut MS3Record) -> Self

Creates a MSRecord from a raw pointer. Takes ownership.

Safety

Takes ownership of a raw MS3Record pointer that was allocated by foreign code.

pub fn into_raw(self) -> *mut MS3Record

Consumes the MSRecord and transfers ownership of the record to a C caller.

pub fn unpack_data(&mut self) -> MSResult<c_long>

Unpacks the packed data of the record and returns the number of unpacked samples.

If the data is already unpacked, the number of previously unpacked samples is returned.

pub fn sid(&self) -> MSResult<String>

Returns the FDSN source identifier.

pub fn sid_lossy(&self) -> String

Returns a lossy version of the FDSN source identifier.

pub fn network(&self) -> MSResult<String>

Returns the network code identifier of the record.

pub fn station(&self) -> MSResult<String>

Returns the station code identifier of the record.

pub fn location(&self) -> MSResult<String>

Returns the location code identifier of the record.

pub fn channel(&self) -> MSResult<String>

Returns the channel code identifier of the record.

pub fn raw(&self) -> Option<&[c_uchar]>

Returns the raw miniSEED record, if available.

pub fn format_version(&self) -> c_uchar

Returns the major format version of the underlying record.

pub fn flags(&self) -> MSBitFieldFlags

Returns the record level bit field flags.

pub fn start_time(&self) -> MSResult<OffsetDateTime>

Returns the start time of the record (i.e. the time of the first sample).

pub fn end_time(&self) -> MSResult<OffsetDateTime>

Calculates the end time of the last sample in the record.

pub fn sample_rate_hz(&self) -> c_double

Returns the nominal sample rate as samples per second (Hz)

pub fn encoding(&self) -> MSResult<MSDataEncoding>

Returns the data encoding format of the record.

pub fn pub_version(&self) -> c_uchar

Returns the record publication version.

pub fn sample_cnt(&self) -> c_long

Returns the number of data samples as indicated by the raw record.

pub fn crc(&self) -> c_uint

Returns the CRC of the record.

pub fn data_length(&self) -> c_ushort

Returns the length of the data payload in bytes.

pub fn extra_headers(&self) -> Option<&[c_uchar]>

Returns the records’ extra headers, if available.

pub fn data_samples<T>(&self) -> Option<&[T]>

Returns the (unpacked) data samples of the record if available.

pub fn data_size(&self) -> usize

Returns the size of the (unpacked) data samples in bytes.

pub fn num_samples(&self) -> c_long

Returns the number of (unpacked) data samples.

pub fn sample_type(&self) -> MSSampleType

Returns the record sample type.

pub fn try_clone(&self) -> MSResult<Self>

Creates a new independently owned MSRecord from the underlying record.

pub fn display(&self, detail: i8) -> RecordDisplay<'_>

Returns an object that implements Display for printing a record with level detail.

The detail flag controls the level of detail displayed:

• 0: print a single summary line
• 1: print most header details
• >1: print all header details

Examples

Print most header details (i.e. detail 1) of miniSEED records from a file:

use mseed::MSReader;

let mut reader = MSReader::new("path/to/data.mseed").unwrap();

while let Some(msr) = reader.next() {
   let msr = msr.unwrap();
   print!("{}", msr.display(1));
}

Trait Implementations

impl AsRef<[u8]> for MSRecord

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for MSRecord

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

Formats the value using the given formatter.

impl Display for MSRecord

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

Formats the value using the given formatter.

impl Drop for MSRecord

fn drop(&mut self)

Executes the destructor for this type.