Struct Scan 

pub struct Scan<'a> { /* private fields */ }

A data section indexed by scan: the parsed header and an iterator over the framed data records.

Implementations

impl<'a> Scan<'a>

pub const fn header(&self) -> &HeaderSection

The parsed header section.

pub const fn input(&self) -> &'a [u8]

The input this scan indexes.

pub fn records(&self) -> Records<'a>

Iterates over the data records in source order. After the last record the iterator checks ENDSEC; and the end marker; a defect anywhere is yielded as an error, after which the iterator ends.

pub fn decode( &self, record: &ScannedRecord<'_>, ) -> Result<DataRecord, StepError>

Decodes one scanned record with owned text, exactly as parse returns it.

Errors

Returns the syntax error inside the record, if any.

pub fn decode_with( &self, record: &ScannedRecord<'_>, options: ParseOptions, ) -> Result<(DataRecord, Vec<Diagnostic>), StepError>

Self::decode under options, as parse_with reads the record, with the record’s diagnostics.

Errors

Returns the syntax error inside the record, if any.

Trait Implementations

impl<'a> Clone for Scan<'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> Debug for Scan<'a>

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

Formats the value using the given formatter.