Files
BitLogger/docs/api/library-async-logger-info.md
T
2026-06-14 00:12:51 +08:00

2.4 KiB

name, group, category, update-time, description, key-word
name group category update-time description key-word
library-async-logger-info api facade 20260614 Enqueue an info-level record through a LibraryAsyncLogger facade using the informational severity shortcut and the repo's direct async call style.
async
library
info
public

Library-async-logger-info

Enqueue an info-level record through the library-facing async logger. This is the convenience wrapper for log(Level::Info, ...) on LibraryAsyncLogger[S].

Interface

pub async fn[S] LibraryAsyncLogger::info(
  self : LibraryAsyncLogger[S],
  message : String,
  fields~ : Array[@bitlogger.Field] = [],
) -> Unit {

input

  • self : LibraryAsyncLogger[S] - Library-facing async logger that should receive the info record.
  • message : String - Info message text.
  • fields : Array[@bitlogger.Field] - Optional structured fields added to the record.

output

  • Unit - No return value. The record is handled according to logger state and policy.

Explanation

Detailed rules explaining key parameters and behaviors

  • This helper delegates to log(Level::Info, ...) on the wrapped async logger.
  • The record is still subject to min-level gating, patching, filtering, and overflow policy.
  • Info is often the default operational logging level for async application events.
  • Use this helper when explicit info intent is clearer than a raw log(...) call.

How to Use

Here are some specific examples provided.

When Need Normal Operational Async Library Events

When async package code should report routine progress or lifecycle events:

logger.info("worker started")

In this example, the event is expressed at the common operational logging level through the narrower facade.

When Add Structured Operational Metadata

When an info event should include stable structured detail:

logger.info(
  "job queued",
  fields=[@bitlogger.field("queue", "sync")],
)

In this example, the record remains concise while still carrying useful metadata.

Error Case

e.g.:

  • If the logger minimum level is above Info, the record is skipped before enqueue.

  • If the logger is closed or overflow policy prevents acceptance, the write may not become a normal queued record.

Notes

  1. This is often the most common convenience method for normal async library events.

  2. Use log(...) when the call site needs a dynamic level or target override.