mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-24 00:42:18 +00:00
📝 refine configured file control docs
This commit is contained in:
@@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_close(self : ConfiguredLogger) -> Bool {}
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks forward directly to file close behavior.
|
||||
- Queued file sinks flush queue work before closing the wrapped file sink.
|
||||
- Plain file sinks forward directly to file close behavior through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks flush queue work before closing the wrapped inner file sink.
|
||||
- Non-file sinks return `false`.
|
||||
- This helper is narrower than generic `close()` because it specifically targets file sink shutdown.
|
||||
|
||||
|
||||
@@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_flush(self : ConfiguredLogger) -> Bool {}
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks forward directly to file flush behavior.
|
||||
- Queued file sinks first flush queued records, then flush the wrapped file sink.
|
||||
- Plain file sinks forward directly to file flush behavior through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks first flush queued records, then flush the wrapped inner file sink.
|
||||
- Non-file sinks return `false`.
|
||||
- This helper is narrower than generic `flush()` because it targets file sink behavior specifically.
|
||||
|
||||
|
||||
@@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_reopen_append(self : ConfiguredLogger) -> Bool {}
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks reopen in append mode.
|
||||
- Queued file sinks forward reopen behavior to the wrapped file sink.
|
||||
- Plain file sinks reopen in append mode through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks forward reopen behavior to the wrapped inner file sink.
|
||||
- This helper is a specialized shortcut for a common reopen mode.
|
||||
- Non-file sinks return `false`.
|
||||
|
||||
|
||||
@@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_reopen_truncate(self : ConfiguredLogger) -> Bool {
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks reopen in truncate mode.
|
||||
- Queued file sinks forward reopen behavior to the wrapped file sink.
|
||||
- Plain file sinks reopen in truncate mode through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks forward reopen behavior to the wrapped inner file sink.
|
||||
- This helper is a specialized shortcut for a common reset-style reopen mode.
|
||||
- Non-file sinks return `false`.
|
||||
|
||||
|
||||
@@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_reopen_with_current_policy(self : ConfiguredLogger
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks reuse their current stored reopen policy.
|
||||
- Queued file sinks forward reopen behavior to the wrapped file sink.
|
||||
- Plain file sinks reuse their current stored reopen policy through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks forward reopen behavior to the wrapped inner file sink.
|
||||
- This helper differs from `file_reopen(...)` because it does not accept a per-call append override.
|
||||
- Non-file sinks return `false`.
|
||||
|
||||
|
||||
@@ -34,8 +34,8 @@ pub fn ConfiguredLogger::file_reopen(self : ConfiguredLogger, append~ : Bool? =
|
||||
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- Plain file sinks reopen directly.
|
||||
- Queued file sinks forward reopen behavior to the wrapped file sink.
|
||||
- Plain file sinks reopen directly through the wrapped `RuntimeSink`.
|
||||
- Queued file sinks forward reopen behavior to the wrapped inner file sink.
|
||||
- `append=None` preserves current reopen policy, while `Some(true/false)` overrides append mode.
|
||||
- Non-file sinks return `false`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user