Struct flexi_logger::FileSpec
source · [−]pub struct FileSpec { /* private fields */ }
Expand description
Builder object for specifying the name and path of the log output file.
assert_eq!(
FileSpec::default()
.directory("/a/b/c")
.basename("foo")
.suppress_timestamp()
.suffix("bar"),
FileSpec::try_from("/a/b/c/foo.bar").unwrap()
);
Implementations
The provided path should describe a log file. If it exists, it must be a file, not a folder. If necessary, parent folders will be created.
Errors
FlexiLoggerError::OutputBadFile
if the given path exists and is a folder.
Panics
Panics if the basename of the given path has no filename
The specified String is used as the basename of the log file name, instead of the program name. Using a file separator within the argument is discouraged.
The specified String is used as the basename of the log file,
instead of the program name, which is used when None
is given.
Specifies a folder for the log files.
If the specified folder does not exist, it will be created. By default, the log files are created in the folder where the program was started.
Specifies a folder for the log files.
If the specified folder does not exist, it will be created. With None, the log files are created in the folder where the program was started.
The specified String is added to the log file name.
The specified String is added to the log file name.
Specifies a suffix for the log files.
Equivalent to o_suffix(Some(suffix))
.
Specifies a suffix for the log files, or supresses the use of a suffix completely.
The default suffix is “log”.
Makes the logger not include a timestamp into the names of the log files
Equivalent to use_timestamp(false)
.
Defines if a timestamp should be included into the names of the log files.
The default behavior depends on the usage:
- without rotation, a timestamp is by default included into the name
- with rotation, the timestamp is by default suppressed
Creates a PathBuf
to the described log file.
It is composed like this:
<directory>/<basename>_<discr>_<timestamp><infix>.<suffix>
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for FileSpec
impl UnwindSafe for FileSpec
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more