Skip to main content

EveJsonWriter

Struct EveJsonWriter 

Source
pub struct EveJsonWriter<W>
where W: Write,
{ /* private fields */ }
Available on crate features emit-eve and emit only.
Expand description

Suricata EVE JSON writer. One JSON object per line.

Each write_event call: clears the per-event JSON Map, fills the required + optional fields, calls serde_json::to_writer straight into the sink, then writes the trailing newline. No intermediate string allocation per event.

Implementations§

Source§

impl<W> EveJsonWriter<W>
where W: Write,

Source

pub fn new(sink: W) -> Self

Construct with default options.

Source

pub fn with_options(sink: W, options: EveOptions) -> Self

Construct with custom options.

Source

pub fn write_event<K>(&mut self, ev: &FlowEvent<K>) -> Result<()>
where K: KeyFields,

Write one event. Skipped variants per EveOptions produce no output and return Ok(()).

Source

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

Flush the underlying sink.

Source

pub fn finish(self) -> Result<W>

Flush and recover the underlying sink.

Source

pub fn write_owned_anomaly(&mut self, a: &OwnedAnomaly) -> Result<()>

Emit event_type: "anomaly" from a canonical crate::OwnedAnomaly.

Schema mapping:

See crate::OwnedAnomaly for canonical detector- shaped emission. Use Self::write_event for flowscope-internal FlowEvent variants.

Auto Trait Implementations§

§

impl<W> Freeze for EveJsonWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for EveJsonWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for EveJsonWriter<W>
where W: Send,

§

impl<W> Sync for EveJsonWriter<W>
where W: Sync,

§

impl<W> Unpin for EveJsonWriter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for EveJsonWriter<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for EveJsonWriter<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more