Struct mseed::PackInfo

pub struct PackInfo {
    pub sample_rate: c_double,
    pub format_version: c_uchar,
    pub pub_version: c_uchar,
    pub flags: MSBitFieldFlags,
    pub encoding: MSDataEncoding,
    pub rec_len: c_int,
    pub extra_headers: Option<CString>,
    /* private fields */
}

Struct providing miniSEED record packing information.

Fields

sample_rate: c_double

Record sample rate.

format_version: c_uchar

The miniSEED format version.

pub_version: c_uchar

Publication version.

flags: MSBitFieldFlags

Bit field flags.

encoding: MSDataEncoding

Data encoding.

rec_len: c_int

Record length used for encoding.

extra_headers: Option<CString>

Extra headers.

If not None it is expected to contain extra headers, i.e. a string containing (compact) JSON, that will be added to each output record.

Implementations

impl PackInfo

pub fn new<T>(sid: T) -> MSResult<Self>

where T: Into<Vec<u8>>,

Creates a new PackInfo from a FDSN source identifier.

pub fn with_sample_rate<T>(sid: T, sample_rate: c_double) -> MSResult<Self>

where T: Into<Vec<u8>>,

Creates a new PackInfo from a FDSN source identifier with configured sample rate.

Note that by libmseed convention a negative sample_rate value is considered as a sample rate period (i.e. in units of seconds (s)), while a positive sample rate value is considered as a sample rate frequency (i.e. in units of Hertz (Hz)).

See also factor_multiplier_to_sample_rate.

pub fn sid(&self) -> &CString

Returns a reference to the FDSN source identifier.

pub fn set_sid<T>(&mut self, sid: T) -> MSResult<()>

where T: Into<Vec<u8>>,

Sets the FDSN source identifier.

Trait Implementations

impl Clone for PackInfo

fn clone(&self) -> PackInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackInfo

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

Formats the value using the given formatter.