Struct Header 

pub struct Header {
    pub protocol_version: u32,
    pub name: String,
    pub channels: Vec<Channel>,
    pub sample_rate_hz: Option<Ratio>,
    pub format: i32,
    pub samples: u64,
    pub start_time_s: Option<Ratio>,
    pub metadata: HashMap<String, String>,
}

What a recording is: the answer to Open, and part of ServerInfo.

Fields

protocol_version: u32

name: String

channels: Vec<Channel>

sample_rate_hz: Option<Ratio>

format: i32

samples: u64

Samples per channel; 0 for a live source of unknown length.

start_time_s: Option<Ratio>

Time of sample 0 from the acquisition start.

metadata: HashMap<String, String>

Implementations

impl Header

pub fn format(&self) -> SampleFormat

Returns the enum value of format, or the default if the field is set to an invalid enum value.

pub fn set_format(&mut self, value: SampleFormat)

Sets format to the provided enum value.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl Message for Header

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Header

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Header