Struct adder_codec_core::codec::encoder::Encoder
source · pub struct Encoder<W: Write> { /* private fields */ }
Expand description
Struct for encoding Event
s to a stream
Implementations§
source§impl<W: Write + 'static> Encoder<W>
impl<W: Write + 'static> Encoder<W>
sourcepub fn new_empty(compression: EmptyOutput<Sink>) -> Selfwhere
Self: Sized,
pub fn new_empty(compression: EmptyOutput<Sink>) -> Selfwhere Self: Sized,
Create a new Encoder
with an empty compression scheme
sourcepub fn new_raw(compression: RawOutput<W>) -> Selfwhere
Self: Sized,
pub fn new_raw(compression: RawOutput<W>) -> Selfwhere Self: Sized,
Create a new Encoder
with the given raw compression scheme
sourcepub fn new_raw_interleaved(compression: RawOutputInterleaved<W>) -> Selfwhere
Self: Sized,
pub fn new_raw_interleaved(compression: RawOutputInterleaved<W>) -> Selfwhere Self: Sized,
Create a new Encoder
with the given raw 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
TODO: Make this move events, not by reference
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
Auto Trait Implementations§
impl<W> RefUnwindSafe for Encoder<W>where W: RefUnwindSafe,
impl<W> Send for Encoder<W>where W: Send,
impl<W> Sync for Encoder<W>where W: Sync,
impl<W> Unpin for Encoder<W>where W: Unpin,
impl<W> UnwindSafe for Encoder<W>where W: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more