mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-30 23:14:22 +00:00
📝 clarify app text async docs
This commit is contained in:
@@ -3,7 +3,7 @@ name: application-text-async-logger
|
|||||||
group: api
|
group: api
|
||||||
category: facade
|
category: facade
|
||||||
update-time: 20260614
|
update-time: 20260614
|
||||||
description: Application-facing alias for the text-console async logger surface, preserving the same async calling semantics as AsyncLogger.
|
description: Application-facing alias for the text-console async logger surface, preserving the full AsyncLogger helper set for the concrete text sink shape.
|
||||||
key-word:
|
key-word:
|
||||||
- application
|
- application
|
||||||
- async
|
- async
|
||||||
@@ -33,6 +33,7 @@ Detailed rules explaining key parameters and behaviors
|
|||||||
- It preserves the same async lifecycle helpers as other async logger aliases.
|
- It preserves the same async lifecycle helpers as other async logger aliases.
|
||||||
- Because this is only an alias, methods that are async on `AsyncLogger[@bitlogger.FormattedConsoleSink]` remain async here as well.
|
- Because this is only an alias, methods that are async on `AsyncLogger[@bitlogger.FormattedConsoleSink]` remain async here as well.
|
||||||
- The alias therefore keeps the same text-console-specific builder and lifecycle semantics already documented on `AsyncLogger[@bitlogger.FormattedConsoleSink]`, including the concrete sink shape and runtime-dependent close/failure behavior.
|
- The alias therefore keeps the same text-console-specific builder and lifecycle semantics already documented on `AsyncLogger[@bitlogger.FormattedConsoleSink]`, including the concrete sink shape and runtime-dependent close/failure behavior.
|
||||||
|
- The application-facing type does not hide any async state or lifecycle helpers; queue/backlog/failure inspection remains directly available on this alias just as it is on the underlying `AsyncLogger[@bitlogger.FormattedConsoleSink]`.
|
||||||
- The alias exists to give application code a clearer public name when it wants the concrete text-console sink shape explicitly.
|
- The alias exists to give application code a clearer public name when it wants the concrete text-console sink shape explicitly.
|
||||||
- `build_application_text_async_logger(...)` returns this alias.
|
- `build_application_text_async_logger(...)` returns this alias.
|
||||||
|
|
||||||
@@ -62,6 +63,8 @@ async fn start_text_async(logger : ApplicationTextAsyncLogger) -> Unit {
|
|||||||
|
|
||||||
In this example, the app-facing alias communicates the concrete text-console async shape directly, while `run()` keeps its async calling contract.
|
In this example, the app-facing alias communicates the concrete text-console async shape directly, while `run()` keeps its async calling contract.
|
||||||
|
|
||||||
|
And the same pending-count, state, and failure helpers remain directly available because no narrowing wrapper is added.
|
||||||
|
|
||||||
### Error Case
|
### Error Case
|
||||||
|
|
||||||
e.g.:
|
e.g.:
|
||||||
@@ -76,3 +79,5 @@ e.g.:
|
|||||||
2. Use `build_application_text_async_logger(...)` when callers want the `FormattedConsoleSink`-backed async type explicitly.
|
2. Use `build_application_text_async_logger(...)` when callers want the `FormattedConsoleSink`-backed async type explicitly.
|
||||||
|
|
||||||
3. Use `ApplicationAsyncLogger` when application code should keep the broader runtime-sink shape instead of the text-console-specific one.
|
3. Use `ApplicationAsyncLogger` when application code should keep the broader runtime-sink shape instead of the text-console-specific one.
|
||||||
|
|
||||||
|
4. Use `LibraryAsyncLogger[@bitlogger.FormattedConsoleSink]` instead when a library boundary should intentionally narrow the exposed async surface while still preserving the concrete text sink type.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ name: build-application-text-async-logger
|
|||||||
group: api
|
group: api
|
||||||
category: facade
|
category: facade
|
||||||
update-time: 20260614
|
update-time: 20260614
|
||||||
description: Build the application-facing text-console async logger facade from an AsyncLoggerBuildConfig using the configured text formatter directly.
|
description: Build the application-facing text-console async logger alias from an AsyncLoggerBuildConfig using the configured text formatter directly.
|
||||||
key-word:
|
key-word:
|
||||||
- application
|
- application
|
||||||
- async
|
- async
|
||||||
@@ -13,7 +13,7 @@ key-word:
|
|||||||
|
|
||||||
## Build-application-text-async-logger
|
## Build-application-text-async-logger
|
||||||
|
|
||||||
Build an `ApplicationTextAsyncLogger` from `AsyncLoggerBuildConfig`. This facade is the application-oriented async builder for the text-console runtime sink shape returned by `build_async_text_logger(...)`.
|
Build an `ApplicationTextAsyncLogger` from `AsyncLoggerBuildConfig`. This is the application-oriented async alias builder for the text-console runtime sink shape returned by `build_async_text_logger(...)`.
|
||||||
|
|
||||||
### Interface
|
### Interface
|
||||||
|
|
||||||
@@ -35,13 +35,14 @@ pub fn build_application_text_async_logger(
|
|||||||
|
|
||||||
Detailed rules explaining key parameters and behaviors
|
Detailed rules explaining key parameters and behaviors
|
||||||
|
|
||||||
- This API delegates to `build_async_text_logger(...)`.
|
- This API delegates to `build_async_text_logger(...)` directly.
|
||||||
- It is intended for config-driven async text console output where callers want the concrete text sink shape rather than the broader runtime sink enum wrapper.
|
- It is intended for config-driven async text console output where callers want the concrete text sink shape rather than the broader runtime sink enum wrapper.
|
||||||
- The builder always creates a `FormattedConsoleSink` from `config.logger.sink.text_formatter` instead of selecting among sink kinds.
|
- The builder always creates a `FormattedConsoleSink` from `config.logger.sink.text_formatter` instead of selecting among sink kinds.
|
||||||
- Unlike `build_application_async_logger(...)`, this facade does not go through the full synchronous configured-logger build path first.
|
- Unlike `build_application_async_logger(...)`, this alias-oriented builder does not go through the full synchronous configured-logger build path first.
|
||||||
- It uses the selected text-oriented `LoggerConfig` fields directly and therefore does not apply `LoggerConfig.queue` or preserve sync runtime sink controls.
|
- It uses the selected text-oriented `LoggerConfig` fields directly and therefore does not apply `LoggerConfig.queue` or preserve sync runtime sink controls.
|
||||||
- The returned logger keeps the usual async lifecycle helpers.
|
- Because the result is only the `ApplicationTextAsyncLogger` alias over `AsyncLogger[@bitlogger.FormattedConsoleSink]`, this builder does not hide any async helpers or introduce a wrapper layer.
|
||||||
- Because it returns the direct `ApplicationTextAsyncLogger` alias, the resulting logger also keeps the same runtime-dependent close/failure semantics as the underlying `AsyncLogger[@bitlogger.FormattedConsoleSink]`.
|
- The returned logger keeps the full async lifecycle and state helper surface directly, including helpers such as `run()`, `shutdown()`, `pending_count()`, `dropped_count()`, `state()`, `wait_idle()`, `has_failed()`, and `last_error()`.
|
||||||
|
- It also keeps the same runtime-dependent close/failure semantics as the underlying `AsyncLogger[@bitlogger.FormattedConsoleSink]`.
|
||||||
|
|
||||||
### How to Use
|
### How to Use
|
||||||
|
|
||||||
@@ -61,6 +62,17 @@ let logger = build_application_text_async_logger(
|
|||||||
|
|
||||||
In this example, the async logger is built for text-console output specifically.
|
In this example, the async logger is built for text-console output specifically.
|
||||||
|
|
||||||
|
#### When Need Async State Helpers Immediately After Text App Construction
|
||||||
|
|
||||||
|
When application code should keep the ordinary async helper surface directly on the text-console variant:
|
||||||
|
```moonbit
|
||||||
|
let logger = build_application_text_async_logger(config)
|
||||||
|
ignore(logger.pending_count())
|
||||||
|
ignore(logger.state())
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, the application text alias exposes async state helpers directly because no narrowing wrapper is added.
|
||||||
|
|
||||||
### Error Case
|
### Error Case
|
||||||
|
|
||||||
e.g.:
|
e.g.:
|
||||||
@@ -75,3 +87,5 @@ e.g.:
|
|||||||
2. It is most useful when callers want the `FormattedConsoleSink`-backed async type explicitly.
|
2. It is most useful when callers want the `FormattedConsoleSink`-backed async type explicitly.
|
||||||
|
|
||||||
3. Use `build_application_async_logger(...)` instead when callers need the broader runtime-sink build path, including sync queue application through `build_logger(config.logger)`.
|
3. Use `build_application_async_logger(...)` instead when callers need the broader runtime-sink build path, including sync queue application through `build_logger(config.logger)`.
|
||||||
|
|
||||||
|
4. Use `build_library_async_text_logger(...)` instead when the public boundary should narrow the exposed async surface while preserving the same concrete text sink type.
|
||||||
|
|||||||
Reference in New Issue
Block a user