Struct dipstick::Stream

pub struct Stream<W: Write + Send + Sync + 'static> { /* fields omitted */ }

Buffered metrics text output.

Methods

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

pub fn write_to(write: W) -> Stream<W>

Write metric values to provided Write target.

impl Stream<File>

pub fn to_file<P: AsRef<Path>>(file: P) -> Result<Stream<File>>

Write metric values to a file.

pub fn to_new_file<P: AsRef<Path>>(
    file: P,
    clobber: bool
) -> Result<Stream<File>>

Write metrics to a new file.

Creates a new file to dump data into. If clobber is set to true, it allows overwriting existing file, if false, the attempt will result in an error.

impl Stream<Stderr>

pub fn to_stderr() -> Stream<Stderr>

Write metric values to stderr.

impl Stream<Stdout>

pub fn to_stdout() -> Stream<Stdout>

Write metric values to stdout.

Trait Implementations

impl<W: Write + Send + Sync + 'static> Buffered for Stream<W>

fn buffered(&self, buffering: Buffering) -> Self

Return a clone with the specified buffering set.

fn get_buffering(&self) -> Buffering

Return the current buffering strategy.

fn is_buffered(&self) -> bool

Returns false if the current buffering strategy is Buffering::Unbuffered. Returns true otherwise.

impl<W: Write + Send + Sync + 'static> CachedOutput for Stream<W>

fn cached(self, max_size: usize) -> OutputCache

Wrap an output with a metric definition cache. This can provide performance benefits for metrics that are dynamically defined at runtime on each access. Caching is useless if all metrics are statically declared or instantiated programmatically in advance and referenced by a long living variable.

impl<W: Write + Send + Sync + 'static> Clone for Stream<W>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Write + Send + Sync + 'static> Formatting for Stream<W>

fn formatting(&self, format: impl LineFormat + 'static) -> Self

Specify formatting of output.

impl<W: Write + Send + Sync + 'static> Output for Stream<W>

type SCOPE = TextScope<W>

The type of Scope returned byt this output.

fn new_scope(&self) -> Self::SCOPE

Open a new scope for this output.

fn output(&self) -> Self::SCOPE

Deprecated since 0.7.2:

Use new_scope()

Open a new scope for this output.

impl<W: Write + Send + Sync + 'static> QueuedOutput for Stream<W>

fn queued(self, max_size: usize) -> OutputQueue

Wrap this output with an asynchronous dispatch queue.