Struct FileSinkBuilder 

pub struct FileSinkBuilder<ArgPath> { /* private fields */ }

Note

The generics here are designed to check for required fields at compile time, users should not specify them manually and/or depend on them. If the generic concrete types or the number of generic types are changed in the future, it may not be considered as a breaking change.

Implementations

impl<ArgPath> FileSinkBuilder<ArgPath>

pub fn path<P>(self, path: P) -> FileSinkBuilder<PathBuf>

where P: Into<PathBuf>,

The path of the log file.

This parameter is required.

Examples found in repository

examples/02-file.rs (line 21)

fn configure_file_logger() -> Result<(), Box<dyn std::error::Error>> {
    let path = env::current_exe()?.with_file_name("file.log");

    let file_sink = FileSink::builder().path(path).build_arc()?;
    let new_logger = Logger::builder().sink(file_sink).build_arc()?;
    spdlog::set_default_logger(new_logger);

    info!("this log will be written to the file `all.log`");

    Ok(())
}

examples/07-async.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let path = env::current_exe()?.with_file_name("async.log");
    let file_sink = FileSink::builder().path(path).build_arc()?;

    // AsyncPoolSink is a combined sink which wraps other sinks
    let async_pool_sink = AsyncPoolSink::builder().sink(file_sink).build_arc()?;

    let async_logger = Logger::builder()
        .sink(async_pool_sink)
        .flush_level_filter(LevelFilter::All)
        .build_arc()?;

    info!(logger: async_logger, "Hello, async!");

    Ok(())
}

examples/03-logger.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // `spdlog-rs` has a global default logger and logs will be processed by it
    // by default, You can configure it.
    let default_logger = spdlog::default_logger();
    default_logger.set_level_filter(LevelFilter::All);

    // Or completely replace it with a new one.
    let path = env::current_exe()?.with_file_name("all.log");
    let file_sink = FileSink::builder().path(path).build_arc()?;

    let new_logger = Logger::builder()
        .level_filter(LevelFilter::All)
        .flush_level_filter(LevelFilter::MoreSevereEqual(Level::Warn))
        .sink(file_sink.clone())
        .build_arc()?;
    new_logger.set_flush_period(Some(Duration::from_secs(3)));
    spdlog::set_default_logger(new_logger);

    info!("this log will be written to the file `all.log`");

    // In addition to having the global default logger, more loggers are allowed to
    // be configured, stored and used independently.
    let db = AppDatabase::new(file_sink)?;
    db.write_i32(114514);

    Ok(())
}

struct AppDatabase {
    logger: Logger,
}

impl AppDatabase {
    fn new(all_log_sink: Arc<dyn Sink>) -> Result<Self, Box<dyn std::error::Error>> {
        let path = env::current_exe()?.with_file_name("db.log");
        let db_file_sink = FileSink::builder().path(path).build_arc()?;

        let logger = Logger::builder()
            .name("database")
            .level_filter(LevelFilter::All)
            .flush_level_filter(LevelFilter::MoreSevereEqual(Level::Warn))
            .sinks([all_log_sink, db_file_sink])
            .build()?;
        Ok(Self { logger })
    }

pub fn truncate(self, truncate: bool) -> Self

Truncates the contents when opening an existing file.

If it is true, the existing contents of the file will be discarded.

This parameter is optional, and defaults to false.

pub fn capacity(self, capacity: usize) -> Self

Specifies the internal buffer capacity.

This parameter is optional, and defaults to the value consistent with std.

pub fn level_filter(self, level_filter: LevelFilter) -> Self

Specifies a log level filter.

This parameter is optional, and defaults to LevelFilter::All.

pub fn formatter<F>(self, formatter: F) -> Self

where F: Formatter + 'static,

Specifies a formatter.

This parameter is optional, and defaults to FullFormatter.

pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self

Specifies an error handler.

This parameter is optional, and defaults to ErrorHandler::default().

impl FileSinkBuilder<PathBuf>

pub fn build(self) -> Result<FileSink>

Builds a FileSink.

Error

If an error occurs opening the file, Error::CreateDirectory or Error::OpenFile will be returned.

pub fn build_arc(self) -> Result<Arc<FileSink>>

Builds a Arc<FileSink>.

This is a shorthand method for .build().map(Arc::new).

Examples found in repository

examples/02-file.rs (line 21)

fn configure_file_logger() -> Result<(), Box<dyn std::error::Error>> {
    let path = env::current_exe()?.with_file_name("file.log");

    let file_sink = FileSink::builder().path(path).build_arc()?;
    let new_logger = Logger::builder().sink(file_sink).build_arc()?;
    spdlog::set_default_logger(new_logger);

    info!("this log will be written to the file `all.log`");

    Ok(())
}

examples/07-async.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let path = env::current_exe()?.with_file_name("async.log");
    let file_sink = FileSink::builder().path(path).build_arc()?;

    // AsyncPoolSink is a combined sink which wraps other sinks
    let async_pool_sink = AsyncPoolSink::builder().sink(file_sink).build_arc()?;

    let async_logger = Logger::builder()
        .sink(async_pool_sink)
        .flush_level_filter(LevelFilter::All)
        .build_arc()?;

    info!(logger: async_logger, "Hello, async!");

    Ok(())
}

examples/03-logger.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // `spdlog-rs` has a global default logger and logs will be processed by it
    // by default, You can configure it.
    let default_logger = spdlog::default_logger();
    default_logger.set_level_filter(LevelFilter::All);

    // Or completely replace it with a new one.
    let path = env::current_exe()?.with_file_name("all.log");
    let file_sink = FileSink::builder().path(path).build_arc()?;

    let new_logger = Logger::builder()
        .level_filter(LevelFilter::All)
        .flush_level_filter(LevelFilter::MoreSevereEqual(Level::Warn))
        .sink(file_sink.clone())
        .build_arc()?;
    new_logger.set_flush_period(Some(Duration::from_secs(3)));
    spdlog::set_default_logger(new_logger);

    info!("this log will be written to the file `all.log`");

    // In addition to having the global default logger, more loggers are allowed to
    // be configured, stored and used independently.
    let db = AppDatabase::new(file_sink)?;
    db.write_i32(114514);

    Ok(())
}

struct AppDatabase {
    logger: Logger,
}

impl AppDatabase {
    fn new(all_log_sink: Arc<dyn Sink>) -> Result<Self, Box<dyn std::error::Error>> {
        let path = env::current_exe()?.with_file_name("db.log");
        let db_file_sink = FileSink::builder().path(path).build_arc()?;

        let logger = Logger::builder()
            .name("database")
            .level_filter(LevelFilter::All)
            .flush_level_filter(LevelFilter::MoreSevereEqual(Level::Warn))
            .sinks([all_log_sink, db_file_sink])
            .build()?;
        Ok(Self { logger })
    }