From 4e00c5eac5932eee676719c1515f86a34d2e9243 Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sat, 13 Jun 2026 23:51:37 +0800 Subject: [PATCH] :memo: refine configured file status docs --- docs/api/configured-logger-file-append-mode.md | 4 ++-- docs/api/configured-logger-file-auto-flush.md | 4 ++-- docs/api/configured-logger-file-available.md | 4 ++-- docs/api/configured-logger-file-flush-failures.md | 4 ++-- docs/api/configured-logger-file-open-failures.md | 4 ++-- docs/api/configured-logger-file-path.md | 4 ++-- docs/api/configured-logger-file-rotation-failures.md | 4 ++-- docs/api/configured-logger-file-write-failures.md | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api/configured-logger-file-append-mode.md b/docs/api/configured-logger-file-append-mode.md index 79e2678..b0d2698 100644 --- a/docs/api/configured-logger-file-append-mode.md +++ b/docs/api/configured-logger-file-append-mode.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_append_mode(self : ConfiguredLogger) -> Bool {} Detailed rules explaining key parameters and behaviors -- File-backed sinks report their current append policy. -- Queued file sinks forward the policy from the wrapped file sink. +- File-backed sinks report their current append policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the policy from the wrapped inner file sink. - Non-file sinks return `false`. - This helper reports runtime file policy, not whether a file is currently writable. diff --git a/docs/api/configured-logger-file-auto-flush.md b/docs/api/configured-logger-file-auto-flush.md index d8e1b3a..784e958 100644 --- a/docs/api/configured-logger-file-auto-flush.md +++ b/docs/api/configured-logger-file-auto-flush.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_auto_flush(self : ConfiguredLogger) -> Bool {} Detailed rules explaining key parameters and behaviors -- File-backed sinks report their current auto-flush policy. -- Queued file sinks forward the policy from the wrapped file sink. +- File-backed sinks report their current auto-flush policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the policy from the wrapped inner file sink. - Non-file sinks return `false`. - This helper exposes policy state only and does not force any flush action. diff --git a/docs/api/configured-logger-file-available.md b/docs/api/configured-logger-file-available.md index f3c41df..c5efc51 100644 --- a/docs/api/configured-logger-file-available.md +++ b/docs/api/configured-logger-file-available.md @@ -33,9 +33,9 @@ pub fn ConfiguredLogger::file_available(self : ConfiguredLogger) -> Bool {} Detailed rules explaining key parameters and behaviors -- File-backed runtime sinks report actual file availability. +- File-backed runtime sinks report actual file availability through the wrapped `RuntimeSink`. +- Queued file sinks still expose the availability of their wrapped inner file sink. - Non-file sinks report `false`. -- Queued file sinks still expose the availability of their wrapped file sink. - This helper delegates to the runtime sink and does not mutate logger state. ### How to Use diff --git a/docs/api/configured-logger-file-flush-failures.md b/docs/api/configured-logger-file-flush-failures.md index dedb3b9..3e2be8d 100644 --- a/docs/api/configured-logger-file-flush-failures.md +++ b/docs/api/configured-logger-file-flush-failures.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_flush_failures(self : ConfiguredLogger) -> Int {} Detailed rules explaining key parameters and behaviors -- File-backed sinks report their recorded flush-failure count. -- Queued file sinks forward the metric from the wrapped file sink. +- File-backed sinks report their recorded flush-failure count through the wrapped `RuntimeSink`. +- Queued file sinks forward the metric from the wrapped inner file sink. - Non-file sinks return `0`. - The counter is cumulative until reset. diff --git a/docs/api/configured-logger-file-open-failures.md b/docs/api/configured-logger-file-open-failures.md index edccee9..e1d6176 100644 --- a/docs/api/configured-logger-file-open-failures.md +++ b/docs/api/configured-logger-file-open-failures.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_open_failures(self : ConfiguredLogger) -> Int {} Detailed rules explaining key parameters and behaviors -- File-backed sinks report their recorded open-failure count. -- Queued file sinks forward the metric from the wrapped file sink. +- File-backed sinks report their recorded open-failure count through the wrapped `RuntimeSink`. +- Queued file sinks forward the metric from the wrapped inner file sink. - Non-file sinks return `0`. - The counter is cumulative until reset. diff --git a/docs/api/configured-logger-file-path.md b/docs/api/configured-logger-file-path.md index 9cec8f1..5446b5d 100644 --- a/docs/api/configured-logger-file-path.md +++ b/docs/api/configured-logger-file-path.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_path(self : ConfiguredLogger) -> String {} Detailed rules explaining key parameters and behaviors -- File-backed sinks return their current file path. -- Queued file sinks forward the wrapped file sink path. +- File-backed sinks return their current file path through the wrapped `RuntimeSink`. +- Queued file sinks forward the wrapped inner file sink path. - Non-file sinks return an empty string. - This helper is observation-only and does not modify file state. diff --git a/docs/api/configured-logger-file-rotation-failures.md b/docs/api/configured-logger-file-rotation-failures.md index 8247a60..b250345 100644 --- a/docs/api/configured-logger-file-rotation-failures.md +++ b/docs/api/configured-logger-file-rotation-failures.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_rotation_failures(self : ConfiguredLogger) -> Int Detailed rules explaining key parameters and behaviors -- File-backed sinks report their recorded rotation-failure count. -- Queued file sinks forward the metric from the wrapped file sink. +- File-backed sinks report their recorded rotation-failure count through the wrapped `RuntimeSink`. +- Queued file sinks forward the metric from the wrapped inner file sink. - Non-file sinks return `0`. - The counter is cumulative until reset. diff --git a/docs/api/configured-logger-file-write-failures.md b/docs/api/configured-logger-file-write-failures.md index 656b60c..58e27c9 100644 --- a/docs/api/configured-logger-file-write-failures.md +++ b/docs/api/configured-logger-file-write-failures.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_write_failures(self : ConfiguredLogger) -> Int {} Detailed rules explaining key parameters and behaviors -- File-backed sinks report their recorded write-failure count. -- Queued file sinks forward the metric from the wrapped file sink. +- File-backed sinks report their recorded write-failure count through the wrapped `RuntimeSink`. +- Queued file sinks forward the metric from the wrapped inner file sink. - Non-file sinks return `0`. - The counter is cumulative until reset.