Struct adder_codec_core::codec::encoder::Encoder
source · pub struct Encoder<W> { /* private fields */ }
Expand description
Struct for encoding Event
s to a stream
Implementations§
source§impl<W: Write> Encoder<W>
impl<W: Write> Encoder<W>
sourcepub fn new(compression: Box<dyn WriteCompression<W>>) -> Selfwhere
Self: Sized,
pub fn new(compression: Box<dyn WriteCompression<W>>) -> Selfwhere Self: Sized,
Create a new Encoder
with the given compression scheme
sourcepub fn meta(&self) -> &CodecMetadata
pub fn meta(&self) -> &CodecMetadata
Returns a reference to the metadata of the underlying compression scheme
sourcepub fn flush_writer(&mut self) -> Result<()>
pub fn flush_writer(&mut self) -> Result<()>
Flush the BitWriter
. Does not flush the internal BufWriter
.
sourcepub fn close_writer(self) -> Result<Option<W>, CodecError>
pub fn close_writer(self) -> Result<Option<W>, CodecError>
Close the encoder’s writer and return it, consuming the encoder in the process.
sourcepub fn ingest_event(&mut self, event: &Event) -> Result<(), CodecError>
pub fn ingest_event(&mut self, event: &Event) -> Result<(), CodecError>
Ingest an event
sourcepub fn ingest_events(&mut self, events: &[Event]) -> Result<(), CodecError>
pub fn ingest_events(&mut self, events: &[Event]) -> Result<(), CodecError>
Ingest an array of events
sourcepub fn ingest_events_events(
&mut self,
events: &[Vec<Event>]
) -> Result<(), CodecError>
pub fn ingest_events_events( &mut self, events: &[Vec<Event>] ) -> Result<(), CodecError>
Ingest a vector of an array of events