Struct EventView

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

An immutable view to an event in a MIDAS file.

An event is a collection of BankViews.

Implementations

impl<'a> EventView<'a>

pub fn id(&self) -> u16

Returns the event ID.

Examples found in repository

examples/single_bank.rs (line 8)

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 23)

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 trigger_mask(&self) -> u16

Returns the trigger mask of the event.

pub fn serial_number(&self) -> u32

Returns the serial number of the event.

pub fn timestamp(&self) -> u32

Returns the unix timestamp of the event.

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

Returns an iterator over the data banks of the event.

Trait Implementations

impl<'a> Clone for EventView<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EventView<'a>

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

Formats the value using the given formatter.

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

type Item = &'b BankView<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'b, BankView<'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 EventView<'a>

type Item = BankView<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<BankView<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.