Struct midasio::file::FileView

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

An immutable view to a MIDAS file.

A files is a collection of EventViews wrapped by two dumps of the Online Data Base (ODB) at the beginning and end of the sub-run. The binary representation of a file is:

Byte Offset	Size (in bytes)	Description
0	2	Begin-of-run marker (0x8000)
2	2	Magic-midas marker (0x494D)
4	4	Run number
8	4	Initial unix timestamp
12	4	Initial ODB dump size (n)
16	n	Initial ODB dump
16 + n	m	Events
16 + n + m	2	End-of-run marker (0x8001)
18 + n + m	2	Magic-midas marker (0x494D)
20 + n + m	4	Run number
24 + n + m	4	Final unix timestamp
28 + n + m	4	Final ODB dump size (k)
32 + n + m	k	Final ODB dump

Implementations

impl<'a> FileView<'a>

pub fn try_from_bytes( bytes: &'a [u8] ) -> Result<Self, TryFileViewFromBytesError>

Create a native view to the underlying file from its representation as a byte slice. Endianness is determined from the begin-of-run marker.

pub fn run_number(&self) -> u32

Return the run number associated with the file.

pub fn initial_timestamp(&self) -> u32

Return the unix timestamp of the initial ODB dump.

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

Return the initial ODB dump. This is not guaranteed to be valid ASCII nor UTF-8.

pub fn final_timestamp(&self) -> u32

Return the unix timestamp of the final ODB dump.

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

Return the final ODB dump. This is not guaranteed to be valid ASCII nor UTF-8.

pub fn iter(&self) -> Iter<'_, EventView<'a>>

Return an iterator over the events in the file.

Trait Implementations

impl<'a> Clone for FileView<'a>

fn clone(&self) -> FileView<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FileView<'a>

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

Formats the value using the given formatter.

impl<'a, 'b> IntoIterator for &'b FileView<'a>

type Item = &'b EventView<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'b, EventView<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for FileView<'a>

type Item = EventView<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<EventView<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b> IntoParallelIterator for &'b FileView<'a>

Available on crate feature rayon only.

type Item = &'b EventView<'a>

The type of item that the parallel iterator will produce.

type Iter = Iter<'b, EventView<'a>>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.

impl<'a> IntoParallelIterator for FileView<'a>

Available on crate feature rayon only.

type Item = EventView<'a>

The type of item that the parallel iterator will produce.

type Iter = IntoIter<EventView<'a>>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.

impl<'a> TryFrom<&'a [u8]> for FileView<'a>

type Error = TryFileViewFromBytesError

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.