BitLogger/docs/api/application-async-logger.md

name, group, category, update-time, description, key-word

name	group	category	update-time	description	key-word
application-async-logger	api	facade	20260614	Application-facing alias for the runtime-sink async logger surface, preserving the same async calling semantics as AsyncLogger.	application async alias public

Application-async-logger

ApplicationAsyncLogger is the application-facing async logger alias. It currently maps directly to AsyncLogger[@bitlogger.RuntimeSink] and keeps the same async lifecycle, state, and queue helper surface.

Interface

pub type ApplicationAsyncLogger = AsyncLogger[@bitlogger.RuntimeSink]

output

• ApplicationAsyncLogger - Application-facing name for the runtime-sink async logger shape.

Explanation

Detailed rules explaining key parameters and behaviors

• This alias does not introduce a new runtime type or wrapper layer.
• It preserves the same async lifecycle helpers such as run(), shutdown(), pending_count(), and state().
• Because this is only an alias, methods that are async on AsyncLogger[@bitlogger.RuntimeSink] remain async here as well.
• The alias therefore keeps the same runtime-sink lifecycle, queue, failure-state, and runtime-dependent post-close semantics already documented on AsyncLogger[@bitlogger.RuntimeSink].
• In the current direct alias coverage, values built through build_application_async_logger(...) keep the same serialized state snapshot shape, queue counters, lifecycle flags, failure fields, and runtime-sink helper surface that the underlying runtime-sink async logger exposes directly.
• That includes queued runtime-sink behavior and file-backed runtime helpers when the configured sink path supports them.
• The alias exists to give application boot code a clearer public type name for the standard runtime-sink async logger.
• Builders such as build_application_async_logger(...) and parse_and_build_application_async_logger(...) return this alias.

How to Use

Here are some specific examples provided.

When Need An App-level Name For The Standard Async Runtime Logger

When application code wants a stable public type name for the runtime-sink async logger:

let logger : ApplicationAsyncLogger = build_application_async_logger(
  AsyncLoggerBuildConfig::new(logger=LoggerConfig::new(target="app.async")),
)

In this example, the application alias keeps the same underlying async logger behavior while presenting an app-facing type name.

When Pass The Async Logger Through App-level APIs

When top-level boot code or services should expose an application-oriented async logger type:

async fn start_async(logger : ApplicationAsyncLogger) -> Unit {
  logger.run()
}

In this example, callers see the app-facing alias instead of the more explicit generic async logger spelling, while run() keeps its async calling contract.

Error Case

e.g.:

• Because this is only an alias, any runtime-sink limitations or target-specific async behavior still apply unchanged.

• If code needs a narrower public surface than the full async logger API, LibraryAsyncLogger is the better facade.

• If callers need queued runtime-sink helpers or file-backed runtime helpers, they remain directly available on this alias because no wrapper layer strips them away.

Notes

1. This alias is about naming and public intent, not a different async implementation.

2. Use build_application_async_logger(...) or parse_and_build_application_async_logger(...) for the usual construction paths.

3. Use ApplicationTextAsyncLogger or build_application_text_async_logger(...) when application code should keep the narrower text-console sink type instead of the broader runtime-sink alias.