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:
- Underlying IO object, which must implement
Write
andRead
traits or their asynchronous analogues fromtokio
library:AsyncRead
andAsyncWrite
. - Buffer formatting part, which must implement
BufferFormatter
trait provided by this library. This part ofLoggedStream
is responsible for the form you will see the input and output bytes. Currently this library provides the following implementations ofBufferFormatter
trait:UppercaseHexadecimalFormatter
,LowercaseHexadecimalFormatter
,DecimalFormatter
,BinaryFormatter
andOctalFormatter
. AlsoBufferFormatter
is public trait so you are free to construct your own implementation. - Filtering part, which must implement
RecordFilter
trait provide by this library. This part ofLoggedStream
is responsible for log records filtering. Currently this library provides the following implementation ofRecordFilter
trait:DefaultFilter
which accepts all log records andRecordKindFilter
which accepts logs with kinds specified during construct. AlsoRecordFilter
is public trait and you are free to construct your own implementation. - Logging part, which must implement
Logger
trait provided by this library. This part ofLoggedStream
is responsible for further work with constructed, formatter and filtered log record. For example, it can be outputted to console, written to the file, written to database, written to the memory for further use or sended by the channel. Currently this library provides the following implementations ofLogger
trait:ConsoleLogger
,MemoryStorageLogger
,ChannelLogger
andFileLogger
. AlsoLogger
is public trait and you are free to construct your own implementation.
Structs§
- Binary
Formatter - This implementation of
BufferFormatter
trait formats provided bytes buffer in binary number system. - Channel
Logger - Logger implementation that sends log records via an asynchronous channel.
- Console
Logger - Logger implementation that writes log records to the console.
- Decimal
Formatter - This implementation of
BufferFormatter
trait formats provided bytes buffer in decimal number system. - Default
Filter - This is default implementation of
RecordFilter
trait whichcheck
method always returntrue
. It should be constructed usingDefault::default
method. - File
Logger - This implementation of
Logger
trait writes log records (Record
) into provided file. - Logged
Stream - Wrapper for IO objects to log all read and write operations, errors, and drop events.
- Lowercase
Hexadecimal Formatter - This implementation of
BufferFormatter
trait formats provided bytes buffer in hexdecimal number system. - Memory
Storage Logger - Logger implementation that writes log records to an inner
VecDeque
collection. - Octal
Formatter - 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
). - Record
Kind Filter - Implementation of
RecordFilter
that accepts allowedRecordKind
array. - Uppercase
Hexadecimal Formatter - This implementation of
BufferFormatter
trait formats provided bytes buffer in hexadecimal number system.
Enums§
- Record
Kind - 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§
- Buffer
Formatter - 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 insideLoggedStream
. - Logger
- Trait for processing log records in
LoggedStream
. - Record
Filter - Trait for filtering log records in
LoggedStream
.