Struct Encoder

pub struct Encoder<W: Write + Send + Sync + 'static> {
    pub options: EncoderOptions,
    /* private fields */
}

Struct for encoding Events to a stream

Fields

options: EncoderOptions

Implementations

impl<W: Write + 'static + Send + Sync> Encoder<W>

pub fn new_empty( compression: EmptyOutput<Sink>, options: EncoderOptions, ) -> Self

where Self: Sized,

Create a new Encoder with an empty compression scheme

pub fn new_compressed( compression: CompressedOutput<W>, options: EncoderOptions, ) -> Self

where Self: Sized,

Create a new Encoder with the given compression scheme

pub fn new_raw(compression: RawOutput<W>, options: EncoderOptions) -> Self

where Self: Sized,

Create a new Encoder with the given raw compression scheme

pub fn meta(&self) -> &CodecMetadata

Returns a reference to the metadata of the underlying compression scheme

pub fn flush_writer(&mut self) -> Result<()>

Flush the BitWriter. Does not flush the internal BufWriter.

pub fn close_writer(self) -> Result<Option<W>, CodecError>

Close the encoder’s writer and return it, consuming the encoder in the process.

pub fn ingest_event(&mut self, event: Event) -> Result<(), CodecError>

Ingest an event

pub fn ingest_events(&mut self, events: &[Event]) -> Result<(), CodecError>

Ingest an array of events

TODO: Make this move events, not by reference

pub fn ingest_events_events( &mut self, events: &[Vec<Event>], ) -> Result<(), CodecError>

Ingest a vector of an array of events

pub fn get_options(&self) -> EncoderOptions

pub fn sync_crf(&mut self)

Keeps the compressed output options in sync with the encoder options. This prevents us from constantly having to look up a reference-counted variable, which is costly at this scale.