Struct Segment

pub struct Segment {
    pub data: Vec<u16>,
    pub time_interval: u16,
}

A waveform segment.

Fields

data: Vec<u16>

The waveform samples.

time_interval: u16

The time interval, in cycles.

Implementations

impl Segment

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Segment>

Reads a Segment from a path.

Examples

use df2::Segment;
let segment = Segment::from_path("data/one-segment.bin").unwrap();

pub fn from_read<R: Read>(read: &mut R) -> Result<Segment>

Reads a Segment from a Read.

Examples

use std::fs::File;
use df2::Segment;
let mut file = File::open("data/one-segment.bin").unwrap();
let segment = Segment::from_read(&mut file).unwrap();

pub fn len(&self) -> u16

Returns the length of this segment in bytes.

Examples

let segment = Segment::from_path("data/one-segment.bin").unwrap();
assert_eq!(110, segment.len());

pub fn is_empty(&self) -> bool

Returns true if this segment has no data.

Examples

let segment = Segment { data: Vec::new(), time_interval: 0 };
assert!(segment.is_empty());
let segment = Segment::from_path("data/one-segment.bin").unwrap();
assert!(!segment.is_empty());

Trait Implementations

impl Debug for Segment

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

Formats the value using the given formatter.

impl Encodable for Segment

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>

Serialize a value using an Encoder.

impl PartialEq for Segment

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Segment