Crate logged_stream

Source
Expand description

This library provides a LoggedStream structure which can be used as a wrapper for underlying IO object which implements Write and Read traits or their asynchronous analogues from tokio library to enable logging of all read and write operations, errors and drop.

LoggedStream structure constructs from four parts:

Structs§

BinaryFormatter
This implementation of BufferFormatter trait formats provided bytes buffer in binary number system.
ChannelLogger
Logger implementation that sends log records via an asynchronous channel.
ConsoleLogger
Logger implementation that writes log records to the console.
DecimalFormatter
This implementation of BufferFormatter trait formats provided bytes buffer in decimal number system.
DefaultFilter
This is default implementation of RecordFilter trait which check method always return true. It should be constructed using Default::default method.
FileLogger
This implementation of Logger trait writes log records (Record) into provided file.
LoggedStream
Wrapper for IO objects to log all read and write operations, errors, and drop events.
LowercaseHexadecimalFormatter
This implementation of BufferFormatter trait formats provided bytes buffer in hexdecimal number system.
MemoryStorageLogger
Logger implementation that writes log records to an inner VecDeque collection.
OctalFormatter
This implementation of BufferFormatter trait formats provided bytes buffer in octal number system.
Record
This structure represents a log record and contains message string, creation timestamp (DateTime<Utc>) and record kind (RecordKind).
RecordKindFilter
Implementation of RecordFilter that accepts allowed RecordKind array.
UppercaseHexadecimalFormatter
This implementation of BufferFormatter trait formats provided bytes buffer in hexadecimal number system.

Enums§

RecordKind
This enumeration represents log record kind. It is contained inside Record and helps to determine how to work with log record message content which is different for each log record kind.

Traits§

BufferFormatter
This trait allows to format bytes buffer using format_buffer method. It should be implemented for structures which are going to be used as formatting part inside LoggedStream.
Logger
Trait for processing log records in LoggedStream.
RecordFilter
Trait for filtering log records in LoggedStream.