team_logger_io library
The full team_logger API plus file-based log storage (dart:io).
Use this import instead of package:team_logger/team_logger.dart on
platforms with file system access (VM, Flutter mobile/desktop). The core
team_logger.dart library stays platform-independent.
Classes
-
AsyncPublisher<
Log extends CustomLog> - A publisher that processes log events asynchronously.
-
AsyncPublisherWithBuffer<
Log extends CustomLog> - An asynchronous publisher that buffers log events and processes them in batches.
- BbCodeFormatter
-
Compiles inline BBCode (
[b]...[/b],[success]...[/success]) into ANSI escape codes using the theme's message styles. - Closable
- An interface for log-event handlers that can be closed.
- Color16
-
One of the sixteen colours a terminal names itself, set by
CSI 30throughCSI 37and their high-intensity pairs. - Color256
-
One of the 256 colours of the table
CSI 38;5,CSI 48;5andCSI 58;5reach: the sixteen the terminal names, a 6×6×6 cube, and 24 greys. - ConsoleLogPrinter
- The main console publisher: prints logs using a data-driven row layout.
- ControlCodeFormatter
- Escapes C0 control characters into visible symbols.
-
CustomLogFormatter<
Log extends CustomLog, Out extends Object?> - A convenience implementation of CustomLogPublisher that supports transforming a log event before ultimately emitting it.
- CustomLogPreFormatter
-
CustomLogPublisher<
Log extends CustomLog> - An interface for publishing or outputting emitted log events.
- FileLogCodec
- Encodes Logs and session metadata as JSON Lines.
- FileLogSession
- A single log session: an ordered chain of chunk files.
- FileLogSessions
-
Reader for log sessions stored in a directory by
FileLogStorage. - FileLogStorage
- A publisher that stores logs on disk, one session per application run.
- Flushable
- An interface for publishers that can be flushed.
- LazyTags
- LevelLogger
- A single level of a Logger (verbose/debug/info/warning/error/critical).
- Log
- An immutable record of a single log call: sequence number, timestamp, namespace path, message, resolved data, tags, trace ids, error and stack trace.
- LogBlock
- LogBox
- LogConstraints
- LogCustomText
- LogDepthTheme
- LogDivider
- Loggable
- A mixin describing how a class should look in logs.
- LoggableConfig
- Configuration for objectToString.
- LoggableData
- LoggableEffectiveConfig
- LoggableJsonConfig
- Configuration for objectToJson.
- LoggableMultiData
- LoggableMultiView
- LoggableNoView
- The type of Prop.noView: the marker that a property has no view.
-
LoggableTypeConverter<
T extends Object?> -
A converter from a third-party type
Tto LoggableData. - LoggableView
- LoggableWrapper
- Logger
- A namespace logger.
- LogLazyStyle
- LogLevelName
- LogLevels
- LogMainTheme
- The root theme: six per-level LogThemeDatas plus shared styling (quotes, ellipsis, message/value formatters, trace id and tag styles).
- LogMessage
- LogNoData
- The type of Log.noData: the marker that a log carries no data at all.
- LogNoStyle
- LogNum
- LogPath
- LogPreFormatter
- LogRow
-
One output row of
ConsoleLogPrinter: children form the body, tail is right-aligned (typically tags). maxLength limits the width (long content wraps or truncates), maxLines limits the height, when makes the row conditional. - LogStackTrace
- LogStorage
- An in-memory circular buffer of the last maxCount logs.
- LogStorageAdd
- LogStorageClear
- LogStorageEvent
- LogStorageRemove
- LogStyle
- LogStyles
- LogTags
- LogTheme
- LogThemeData
- The styles one log level is drawn with: the colours of the message, the punctuation, the key and the value, the path, the time and the rest.
- LogTime
- LogTraceId
- MultiLogPreFormatter
-
MultiPublisher<
Log extends CustomLog> - A handler that delegates an event to multiple publishers simultaneously.
- NoStyle
- A style that adds nothing to the text.
- NullFormatter
-
Prop<
T extends Object?> - Sanitize
- Markers for LogValueSanitizer.
- SanitizeContext
- A value's position in the output.
- Style
- Represents the currently active text style.
- Styles
- Every style that carries one thing, named and constant.
- TraceId
-
A trace identifier:
123,group-123orgroup-123.suffix. -
TransformPublisher<
Log extends CustomLog> - A publisher that transforms every log before handing it to the wrapped publisher.
- TypeProp
Enums
- FileLogDataFormat
- How Log.data is written to a session file.
- LogTextAlign
- LogVerticalAlign
Typedefs
- LogFn = bool Function(Object message, {LoggableConfig? config, Object? data, Object? error, String? overridePath, StackTrace? stackTrace, Object? tags, TraceId? traceId, Zone? zone})
- LogNumberFormatter = String Function(LogTheme theme, num value, String pattern)
-
A theme's number formatter: it receives the value and the opaque
pattern from
LoggableConfig.intFormat/LoggableConfig.doubleFormatand returns the rendered string. -
LogThemeFormatter<
T extends Object?> = String Function(LogTheme theme, T) -
LogTransformer<
Log extends CustomLog> = Log? Function(Log log) - Transforms a log event before it is published.
- LogValueSanitizer = Object? Function(SanitizeContext ctx)
-
Handles one value on its way into the output of
data.