Struct Builder

pub struct Builder { /* private fields */ }

A Builder that configures and initializes the Godot logger

godot-logger implements the builder pattern as the primary interface to configure and initialize the logger. The configuration has sensible defaults that can be overwritten by calling the corresponding setters on the Builder struct. Once the configuration is done, the logger can be initialized by calling the build method.

Examples

use log::Level;
use godot_logger::GodotLogger;

GodotLogger::builder()
    .default_log_level(Level::Debug)
    .init();

Implementations

impl Builder

pub fn default_log_level(self, default_log_level: Level) -> Self

Sets the default log level

GodotLogger matches all log records against a default log level. By default, only warnings and errors are logged.

Examples

use log::Level;
use godot_logger::GodotLogger;

let mut builder = GodotLogger::builder();
builder = builder.default_log_level(Level::Debug);

pub fn add_filter(self, module: &'static str, level: LevelFilter) -> Self

Adds a filter

Filters override the default log level for specific Rust modules.

Examples

use godot_logger::GodotLogger;
use log::LevelFilter;

GodotLogger::builder().add_filter("godot_logger", LevelFilter::Off);

pub fn init(self) -> Result<(), SetLoggerError>

Initializes the logger

This method consumes the builder and initializes the logger with the current configuration of the builder. After calling this method, log records will be written to Godot’s output console.

Examples

use log::Level;
use godot_logger::GodotLogger;

GodotLogger::builder().init();

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Builder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Builder

fn cmp(&self, other: &Builder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Builder

fn eq(&self, other: &Builder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Builder

fn partial_cmp(&self, other: &Builder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Builder

impl StructuralPartialEq for Builder