Struct tracing_appender::non_blocking::NonBlocking
source · [−]pub struct NonBlocking { /* private fields */ }
Expand description
A non-blocking writer.
While the line between “blocking” and “non-blocking” IO is fuzzy, writing to a file is typically
considered to be a blocking operation. For an application whose Subscriber
writes spans and events
as they are emitted, an application might find the latency profile to be unacceptable.
NonBlocking
moves the writing out of an application’s data path by sending spans and events
to a dedicated logging thread.
This struct implements MakeWriter
from the tracing-subscriber
crate. Therefore, it can be used with the tracing_subscriber::fmt
module
or with any other subscriber/layer implementation that uses the MakeWriter
trait.
Implementations
sourceimpl NonBlocking
impl NonBlocking
sourcepub fn new<T: Write + Send + Sync + 'static>(
writer: T
) -> (NonBlocking, WorkerGuard)
pub fn new<T: Write + Send + Sync + 'static>(
writer: T
) -> (NonBlocking, WorkerGuard)
Returns a new NonBlocking
writer wrapping the provided writer
.
The returned NonBlocking
writer will have the default configuration values.
Other configurations can be specified using the builder interface.
sourcepub fn error_counter(&self) -> ErrorCounter
pub fn error_counter(&self) -> ErrorCounter
Returns a counter for the number of times logs where dropped. This will always return zero if
NonBlocking
is not lossy.
Trait Implementations
sourceimpl Clone for NonBlocking
impl Clone for NonBlocking
sourcefn clone(&self) -> NonBlockingⓘNotable traits for NonBlockingimpl Write for NonBlocking
fn clone(&self) -> NonBlockingⓘNotable traits for NonBlockingimpl Write for NonBlocking
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for NonBlocking
impl Debug for NonBlocking
sourceimpl<'a> MakeWriter<'a> for NonBlocking
impl<'a> MakeWriter<'a> for NonBlocking
type Writer = NonBlocking
type Writer = NonBlocking
The concrete io::Write
implementation returned by make_writer
. Read more
sourcefn make_writer(&'a self) -> Self::Writer
fn make_writer(&'a self) -> Self::Writer
sourceimpl Write for NonBlocking
impl Write for NonBlocking
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn write_all(&mut self, buf: &[u8]) -> Result<()>
fn write_all(&mut self, buf: &[u8]) -> Result<()>
Attempts to write an entire buffer into this writer. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
Determines if this Write
r has an efficient write_vectored
implementation. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl RefUnwindSafe for NonBlocking
impl Send for NonBlocking
impl Sync for NonBlocking
impl Unpin for NonBlocking
impl UnwindSafe for NonBlocking
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<'a, M> MakeWriterExt<'a> for M where
M: MakeWriter<'a>,
impl<'a, M> MakeWriterExt<'a> for M where
M: MakeWriter<'a>,
sourcefn with_max_level(self, level: Level) -> WithMaxLevel<Self>
fn with_max_level(self, level: Level) -> WithMaxLevel<Self>
Wraps self
and returns a MakeWriter
that will only write output
for events at or below the provided verbosity Level
. For instance,
Level::TRACE
is considered to be _more verbosethan
Level::INFO`. Read more
sourcefn with_min_level(self, level: Level) -> WithMinLevel<Self>
fn with_min_level(self, level: Level) -> WithMinLevel<Self>
Wraps self
and returns a MakeWriter
that will only write output
for events at or above the provided verbosity Level
. Read more
sourcefn with_filter<F>(self, filter: F) -> WithFilter<Self, F> where
F: Fn(&Metadata<'_>) -> bool,
fn with_filter<F>(self, filter: F) -> WithFilter<Self, F> where
F: Fn(&Metadata<'_>) -> bool,
Wraps self
with a predicate that takes a span or event’s Metadata
and returns a bool
. The returned MakeWriter
’s
MakeWriter::make_writer_for
method will check the predicate to
determine if a writer should be produced for a given span or event. Read more
sourcefn and<B>(self, other: B) -> Tee<Self, B> where
B: MakeWriter<'a>,
fn and<B>(self, other: B) -> Tee<Self, B> where
B: MakeWriter<'a>,
Combines self
with another type implementing MakeWriter
, returning
a new MakeWriter
that produces writers that write to both
outputs. Read more
sourcefn or_else<W, B>(self, other: B) -> OrElse<Self, B> where
Self: MakeWriter<'a, Writer = EitherWriter<W, Sink>>,
B: MakeWriter<'a>,
W: Write,
fn or_else<W, B>(self, other: B) -> OrElse<Self, B> where
Self: MakeWriter<'a, Writer = EitherWriter<W, Sink>>,
B: MakeWriter<'a>,
W: Write,
Combines self
with another type implementing MakeWriter
, returning
a new MakeWriter
that calls other
’s make_writer
if self
’s
make_writer
returns OptionalWriter::none
. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more