Struct lhef::Reader

pub struct Reader<T> { /* private fields */ }

Reader for the LHEF format

Implementations

impl<T: BufRead> Reader<T>

pub fn new(stream: T) -> Result<Reader<T>, Box<dyn Error>>

Create a new LHEF reader

Example

let file = std::fs::File::open("events.lhe").unwrap();
let file = std::io::BufReader::new(file);
let reader = lhef::Reader::new(file).unwrap();

pub fn version(&self) -> &str

Get the LHEF version

pub fn header(&self) -> &str

Get the LHEF header

pub fn xml_header(&self) -> &Option<XmlTree>

Get the LHEF xml header

pub fn heprup(&self) -> &HEPRUP

Get the run information in HEPRUP format

pub fn hepeup(&mut self) -> Result<Option<HEPEUP>, Box<dyn Error>>

Get the next event in HEPEUP format

Example

let file = std::fs::File::open("events.lhe").unwrap();
let file = std::io::BufReader::new(file);
let mut reader = lhef::Reader::new(file).unwrap();

let event = reader.hepeup().unwrap();
match event {
   Some(event) => println!("Found an event."),
   None => println!("Reached end of event file."),
}

Trait Implementations

impl<T: Debug> Debug for Reader<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<Reader<T>> for Reader<T>

fn eq(&self, other: &Reader<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for Reader<T>