Struct FileView

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

An immutable view to a MIDAS file.

A file is a collection of EventViews wrapped by two dumps of the Online DataBase (ODB) at the beginning and end of the sub-run.

Implementations

impl<'a> FileView<'a>

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

Create a native view to the underlying file from its representation as a byte slice.

Examples found in repository

examples/single_bank.rs (line 5)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let contents = std::fs::read("example.mid")?;
    // Note that if your MIDAS file is compressed, you will need to decompress
    // its contents (using an external crate) before parsing it.
    let file_view = midasio::FileView::try_from_bytes(&contents)?;

    // Iterate only through events with an ID of 1
    for event in file_view.into_iter().filter(|event| event.id() == 1) {
        // Lets assume that these events have multiple data banks, but they are
        // guaranteed to have a single bank with the name "TRGB" (which is the
        // one we are interested in)
        let [trg_bank] = event
            .into_iter()
            .filter(|bank| bank.name() == *b"TRGB")
            .collect::<Vec<_>>()[..]
        else {
            unreachable!();
        };
        // You can now access the data in the bank
        let _trg_data = trg_bank.data();
    }

    Ok(())
}

examples/parallel.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let contents = std::fs::read("example.mid")?;
    // Note that if your MIDAS file is compressed, you will need to decompress
    // its contents (using an external crate) before parsing it.
    let file_view = midasio::FileView::try_from_bytes(&contents)?;

    // We want to process all events with an ID of 1. This can be any complex
    // operation, e.g. reconstructing a vertex
    let mut results = Vec::new();

    #[cfg(feature = "rayon")]
    results.par_extend(
        file_view
            .into_par_iter()
            .filter(|event| event.id() == 1)
            .map(|event| {
                // This is a placeholder for a complex operation
                event.into_iter().count()
            }),
    );
    // The equivalent non-parallel version would be:
    #[cfg(not(feature = "rayon"))]
    results.extend(
        file_view
            .into_iter()
            .filter(|event| event.id() == 1)
            .map(|event| event.into_iter().count()),
    );

    Ok(())
}

pub fn run_number(&self) -> u32

Returns the run number of the file.

pub fn initial_timestamp(&self) -> u32

Returns the unix timestamp of the initial ODB dump.

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

Returns the initial ODB dump.

pub fn final_timestamp(&self) -> u32

Returns the unix timestamp of the final ODB dump.

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

Returns the final ODB dump.

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

Returns an iterator over the events of 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.