Enum StdfRecordView 

pub enum StdfRecordView<'a> {
    FAR(FARView<'a>),
    ATR(ATRView<'a>),
    VUR(VURView<'a>),
    MIR(MIRView<'a>),
    MRR(MRRView<'a>),
    PCR(PCRView<'a>),
    HBR(HBRView<'a>),
    SBR(SBRView<'a>),
    PMR(PMRView<'a>),
    PGR(PGRView<'a>),
    PLR(PLRView<'a>),
    RDR(RDRView<'a>),
    SDR(SDRView<'a>),
    PSR(PSRView<'a>),
    NMR(NMRView<'a>),
    CNR(CNRView<'a>),
    SSR(SSRView<'a>),
    CDR(CDRView<'a>),
    WIR(WIRView<'a>),
    WRR(WRRView<'a>),
    WCR(WCRView<'a>),
    PIR(PIRView<'a>),
    PRR(PRRView<'a>),
    TSR(TSRView<'a>),
    PTR(PTRView<'a>),
    MPR(MPRView<'a>),
    FTR(FTRView<'a>),
    STR(STRView<'a>),
    BPS(BPSView<'a>),
    EPS,
    GDR(GDRView<'a>),
    DTR(DTRView<'a>),
    ReservedRec(ReservedRecView<'a>),
    UnknownRec(ReservedRecView<'a>),
}

Zero-copy view over the field data of a single STDF record.

Unlike StdfRecord, which eagerly parses every field into owned values, a StdfRecordView only records each field’s byte offset and reads a field on demand. It borrows the raw bytes it was built from and never allocates for scalar fields.

A view can be built from:

1. A borrowed RawDataElement (From<&RawDataElement>),
2. A header plus raw field data (StdfRecordView::read_from_bytes).
3. A buffer that includes the 4-byte record header and the raw field data (StdfRecordView::read_from_bytes_with_header).

Variants

FAR(FARView<'a>)

ATR(ATRView<'a>)

VUR(VURView<'a>)

MIR(MIRView<'a>)

MRR(MRRView<'a>)

PCR(PCRView<'a>)

HBR(HBRView<'a>)

SBR(SBRView<'a>)

PMR(PMRView<'a>)

PGR(PGRView<'a>)

PLR(PLRView<'a>)

RDR(RDRView<'a>)

SDR(SDRView<'a>)

PSR(PSRView<'a>)

NMR(NMRView<'a>)

CNR(CNRView<'a>)

SSR(SSRView<'a>)

CDR(CDRView<'a>)

WIR(WIRView<'a>)

WRR(WRRView<'a>)

WCR(WCRView<'a>)

PIR(PIRView<'a>)

PRR(PRRView<'a>)

TSR(TSRView<'a>)

PTR(PTRView<'a>)

MPR(MPRView<'a>)

FTR(FTRView<'a>)

STR(STRView<'a>)

BPS(BPSView<'a>)

EPS

GDR(GDRView<'a>)

DTR(DTRView<'a>)

ReservedRec(ReservedRecView<'a>)

UnknownRec(ReservedRecView<'a>)

Implementations

impl<'a> StdfRecordView<'a>

pub fn read_from_bytes( header: RecordHeader, raw_data: &'a [u8], byte_order: &ByteOrder, ) -> Self

Build a view from RecordHeader, raw field data and byte order.

use rust_stdf::{StdfRecordView, ByteOrder, RecordHeader, stdf_record_type::REC_PTR};

let header = RecordHeader { len: 0, typ: 15, sub: 10 }; // PTR
let raw: [u8; 0] = []; // empty field data; getters fall back to defaults
let view = StdfRecordView::read_from_bytes(header, &raw, &ByteOrder::LittleEndian);

if let StdfRecordView::PTR(ptr_view) = view {
    assert_eq!(0, ptr_view.test_num());
}
assert!(view.is_type(REC_PTR));

pub fn read_from_bytes_with_header( raw_data: &'a [u8], order: &ByteOrder, ) -> Result<Self, StdfError>

Parse a StdfRecordView from byte data that contains the record header (len, typ, sub).

Error

Returns StdfError when the input is not a valid header or is incomplete (the buffer is shorter than the header declares).

use rust_stdf::{StdfRecordView, ByteOrder};

let raw_with_header: [u8; 6] = [0, 2, 0, 10, 1, 4];
let view = StdfRecordView::read_from_bytes_with_header(
    &raw_with_header,
    &ByteOrder::BigEndian,
).unwrap();

if let StdfRecordView::FAR(far_view) = view {
    assert_eq!(4, far_view.stdf_ver());
}

pub fn get_type(&self) -> u64

Return the record type code (see stdf_record_type::*).

pub fn is_type(&self, rec_type: u64) -> bool

Check whether this view belongs to the given record type(s).

pub fn to_owned(&self) -> StdfRecord

Parse this borrowed view into an owned StdfRecord, escaping the borrow of the underlying buffer.

Trait Implementations

impl<'a> Clone for StdfRecordView<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for StdfRecordView<'a>

impl<'a> Debug for StdfRecordView<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a RawDataElement> for StdfRecordView<'a>

fn from(raw_element: &'a RawDataElement) -> Self

Build a zero-copy view; does not consume the input.

impl<'a> From<&RawDataElementView<'a>> for StdfRecordView<'a>

fn from(raw_view: &RawDataElementView<'a>) -> Self

Build a zero-copy view; does not consume the input.

impl<'a> From<&StdfRecordView<'a>> for StdfRecord

fn from(view: &StdfRecordView<'a>) -> Self

Parse the borrowed view into an owned record; does not consume the view.