Struct hepmc2::writer::Writer

pub struct Writer<T: Write> { /* private fields */ }

Writer for the HepMC2 format

Implementations

impl<T: Default + Write> Writer<T>

pub fn into_inner(self) -> T

Retrieve the underlying writer

impl<T: Write> Writer<T>

pub fn new(stream: T) -> Result<Self, Error>

Construct new Writer

This automatically tries to write the mandatory HepMC header, which may fail.

Example

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output)?;
 // always call finish at the end
 writer.finish()?;

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output).await.unwrap();
 // always call finish at the end
 writer.finish().await.unwrap();

pub fn with_header<U: Display>(stream: T, header: U) -> Result<Self, Error>

Construct new Writer, trying to write a custom header

hepmc2 ignores headers, but other implementations of the format may be less lenient.

Example

Sync

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::with_header(output, "")?;
 // always call finish at the end
 writer.finish()?;

Async

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::with_header(output, "").await.unwrap();
 // always call finish at the end
 writer.finish().await.unwrap();

pub fn finish(self) -> Result<(), Error>

Finish writing, consuming the Writer

This tries to write the mandatory HepMC footer, which may fail.

Example

Sync

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output)?;
 // always call finish at the end
 writer.finish()?;

Async

 use hepmc2::writer::Writer;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output).await.unwrap();
 // always call finish at the end
 writer.finish().await.unwrap();

pub fn write(&mut self, event: &Event) -> Result<(), Error>

Write an event

Example

Sync

 use hepmc2::writer::Writer;
 use hepmc2::event::Event;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output)?;
 let event = Event::default();
 writer.write(&event)?;
 // always call finish at the end
 writer.finish()?;

Async

 use hepmc2::writer::Writer;
 use hepmc2::event::Event;

 let mut output = Vec::new();
 let mut writer = Writer::new(&mut output).await.unwrap();
 let event = Event::default();
 writer.write(&event).await.unwrap();
 // always call finish at the end
 writer.finish().await.unwrap();

pub fn try_from(stream: T) -> Result<Self, Error>

Trait Implementations

impl<T: Debug + Write> Debug for Writer<T>

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

Formats the value using the given formatter.

impl<T: Default + Write> Default for Writer<T>

fn default() -> Writer<T>

Returns the “default value” for a type.

impl<T: Write> Drop for Writer<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Hash + Write> Hash for Writer<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + Write> Ord for Writer<T>

fn cmp(&self, other: &Writer<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq + Write> PartialEq for Writer<T>

fn eq(&self, other: &Writer<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: PartialOrd + Write> PartialOrd for Writer<T>

fn partial_cmp(&self, other: &Writer<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + Write> Eq for Writer<T>

impl<T: Write> StructuralPartialEq for Writer<T>