mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-24 00:42:18 +00:00
Nanaloveyuki
90 lines
3.0 KiB
Markdown
90 lines
3.0 KiB
Markdown
---
|
|
name: library-async-logger-is-enabled
|
|
group: api
|
|
category: facade
|
|
update-time: 20260614
|
|
description: Check whether a LibraryAsyncLogger facade passes the wrapped async logger's min-level gate for a given severity.
|
|
key-word:
|
|
- async
|
|
- library
|
|
- enabled
|
|
- public
|
|
---
|
|
|
|
## Library-async-logger-is-enabled
|
|
|
|
Check whether a `LibraryAsyncLogger[S]` would accept a record at the given level based on its current `min_level`. This is the library-facing counterpart to `AsyncLogger::is_enabled(...)` and is useful for gating expensive async message preparation.
|
|
|
|
### Interface
|
|
|
|
```moonbit
|
|
pub fn[S] LibraryAsyncLogger::is_enabled(
|
|
self : LibraryAsyncLogger[S],
|
|
level : @bitlogger.Level,
|
|
) -> Bool {
|
|
```
|
|
|
|
#### input
|
|
|
|
- `self : LibraryAsyncLogger[S]` - Library-facing async logger whose current minimum level should be checked.
|
|
- `level : @bitlogger.Level` - Candidate severity to test.
|
|
|
|
#### output
|
|
|
|
- `Bool` - `true` when the level is enabled by the facade's current threshold.
|
|
|
|
### Explanation
|
|
|
|
Detailed rules explaining key parameters and behaviors
|
|
|
|
- This method delegates directly to the wrapped async logger's `is_enabled(...)` behavior.
|
|
- It only checks logger-level severity gating through `min_level`; it does not evaluate later filter, patch, closed-on-log, or overflow behavior.
|
|
- The result reflects the current wrapped logger state, so derived facades with different thresholds can return different answers.
|
|
- This check does not require unwrapping because it is part of the narrower library-facing surface.
|
|
- Use it when message construction or field gathering is expensive enough to justify a pre-check.
|
|
|
|
### How to Use
|
|
|
|
Here are some specific examples provided.
|
|
|
|
#### When Avoid Expensive Async Debug Preparation
|
|
|
|
When debug data should only be built if needed:
|
|
```moonbit
|
|
if logger.is_enabled(@bitlogger.Level::Info) {
|
|
logger.info(build_summary())
|
|
}
|
|
```
|
|
|
|
In this example, expensive preparation is skipped unless the current threshold allows that severity.
|
|
|
|
#### When Inspect Effective Async Facade Threshold
|
|
|
|
When package code should branch based on current logger behavior:
|
|
```moonbit
|
|
if logger.is_enabled(@bitlogger.Level::Warn) {
|
|
logger.warn("slow path active")
|
|
}
|
|
```
|
|
|
|
In this example, the check mirrors the same severity gate used by later async write calls.
|
|
|
|
And a `true` result still means only that the level gate passed, not that the record is guaranteed to reach the sink.
|
|
|
|
### Error Case
|
|
|
|
e.g.:
|
|
- If `level` is below the current minimum threshold, the method returns `false`.
|
|
|
|
- A `true` result does not guarantee final delivery if later queue or filter behavior rejects the record.
|
|
|
|
- If callers need to inspect queue or failure state instead of only checking the level gate, they must unwrap first with `to_async_logger()`.
|
|
|
|
### Notes
|
|
|
|
1. This is a cheap severity check, not a full end-to-end delivery guarantee.
|
|
|
|
2. Prefer using it only when precomputing the async log payload is meaningfully expensive.
|
|
|
|
3. Use `log(...)` or the severity shortcuts directly when no expensive precomputation needs to be avoided.
|