Skip to Content
VectorLib

BaseSink

vectorlib::BaseSink — fields, methods, parameters and return types.


pub struct BaseSink

A log sink. Port of lemlib::BaseSink and its InfoSink / TelemetrySink subclasses.

A sink built with BaseSink::combined forwards to its children instead of printing, like LemLib's BaseSink(std::initializer_list<std::shared_ptr<BaseSink>>).

View source

Methods

Prop

Type

combined

pub fn combined(sinks: Vec<Rc<BaseSink>>) -> Self

A sink that forwards every message to sinks.

Parameters

Prop

Type

Returns

Self

View source

new_info

pub fn new_info() -> Self

The [VectorLib] {level}: {message} sink printed to the terminal.

Returns

Self

View source

new_telemetry

pub fn new_telemetry() -> Self

The telemetry sink: TELE_{level}:{message}TELE_END, framed so terminals hide it.

Returns

Self

View source

set_lowest_level

pub fn set_lowest_level(&self, level: Level)

Set the lowest level that will be sent. Messages below it are dropped. Warn by default.

Parameters

Prop

Type

Returns

()

View source

set_format

pub fn set_format(&self, format: &str)

Set the format string. {time}, {level} and {message} are substituted.

Parameters

Prop

Type

Returns

()

View source

log

pub fn log(&self, level: Level, args: fmt::Arguments<'_>)

Log a message at level.

Parameters

Prop

Type

Returns

()

View source

debug

pub fn debug(&self, args: fmt::Arguments<'_>)

Log at Debug.

Parameters

Prop

Type

Returns

()

View source

info

pub fn info(&self, args: fmt::Arguments<'_>)

Log at Info.

Parameters

Prop

Type

Returns

()

View source

warn

pub fn warn(&self, args: fmt::Arguments<'_>)

Log at Warn.

Parameters

Prop

Type

Returns

()

View source

error

pub fn error(&self, args: fmt::Arguments<'_>)

Log at Error.

Parameters

Prop

Type

Returns

()

View source

fatal

pub fn fatal(&self, args: fmt::Arguments<'_>)

Log at Fatal.

Parameters

Prop

Type

Returns

()

View source