Configured-logger-file-close
Close the file sink behind a ConfiguredLogger. This helper is the file-specific runtime close surface for config-built file loggers.
Interface
pub fn ConfiguredLogger::file_close(self : ConfiguredLogger) -> Bool {}input
self : ConfiguredLogger- Config-driven runtime logger whose file sink should be closed.
output
Bool- Whether the underlying file close succeeded.
Explanation
Detailed rules explaining key parameters and behaviors
- 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. - After a file-backed configured logger has already cleared its file handle, later
file_close()calls returnfalse.
How to Use
Here are some specific examples provided.
When Need File-specific Runtime Teardown
When a config-built file logger should close its file handle explicitly:
ignore(logger.file_close())In this example, file teardown happens through the configured logger facade.
When Need A File-specific Close Result
When application code wants the file close outcome directly:
let closed = logger.file_close()In this example, the result describes file close behavior rather than generic sink close behavior.
Error Case
e.g.:
If the configured sink is not file-backed, the method returns
false.If the file handle was already closed earlier through this logger or another facade sharing the same wrapped runtime sink state, the method returns
false.If callers only need generic sink teardown,
close()is the broader API.
Notes
Prefer this helper when file-backed runtime behavior matters specifically.
Queued file sinks flush pending records before closing the file, unlike generic
close().Library or application facades derived from the same configured runtime logger still observe the same underlying file-close state.