Skip to main content

AsyncBackend

Struct AsyncBackend 

Source
pub struct AsyncBackend { /* private fields */ }
Expand description

Writes events on a dedicated thread.

§Examples

use ash_log::*;
use std::sync::Arc;

let backend = AsyncBackend::builder(Arc::new(StdoutAuditBackend))
    .capacity(4096)
    .overflow(OverflowPolicy::DropAndReport)
    .errors(Arc::new(StderrErrorSink))
    .build();

let logger = Logger::builder(Arc::new(backend)).build();
logger.info("does not block on the write");
logger.flush(); // waits for the queue to drain

Implementations§

Source§

impl AsyncBackend

Source

pub fn builder(inner: Arc<dyn AuditBackend>) -> AsyncBackendBuilder

Start building an async backend wrapping inner.

Source

pub fn new(inner: Arc<dyn AuditBackend>) -> Self

Wrap inner with default settings: a 1024-event queue that blocks when full.

Source

pub fn dropped(&self) -> u64

Events dropped because the queue was full.

Always 0 under OverflowPolicy::Block.

Trait Implementations§

Source§

impl AuditBackend for AsyncBackend

Source§

fn log_audit(&self, event: &AuditEvent)

Write an audit event
Source§

fn security_log(&self, event: &Value)

Write a raw OCSF (or other JSON) security event as a JSON line. Read more
Source§

fn flush(&self)

Flush buffered entries
Source§

impl Debug for AsyncBackend

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for AsyncBackend

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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