FileLogger

hyperlane_log

Struct FileLogger 

Source 
pub struct FileLogger { /* private fields */ }
Expand description

Main configuration structure for log file output.

Controls where logs are stored and their maximum size limits. Use FileLogger::new() to create an instance with custom settings.

Implementations§

Source§

impl FileLogger

Source

pub fn new<P: AsRef<str>>(path: P, limit_file_size: usize) -> Self

Creates new FileLogger configuration with specified parameters.

§Arguments
  • P: AsRef<str> - The path for storing log files, which will be converted to string slice.
  • usize - The maximum file size limit in bytes.
§Returns
  • Self - A new FileLogger instance with specified configuration.
Source

pub fn get_path(&self) -> &String

Gets the log file storage path.

§Returns
  • &String - Reference to the log file storage path.
Source

pub fn get_limit_file_size(&self) -> &usize

Gets the maximum allowed size (in bytes) for individual log files.

§Returns
  • &usize - Reference to the maximum file size limit in bytes.
Source

pub fn get_trace_dir(&self) -> &String

Gets the trace log directory name.

§Returns
  • &String - Reference to the trace log directory name.
Source

pub fn get_debug_dir(&self) -> &String

Gets the debug log directory name.

§Returns
  • &String - Reference to the debug log directory name.
Source

pub fn get_info_dir(&self) -> &String

Gets the info log directory name.

§Returns
  • &String - Reference to the info log directory name.
Source

pub fn get_warn_dir(&self) -> &String

Gets the warn log directory name.

§Returns
  • &String - Reference to the warn log directory name.
Source

pub fn get_error_dir(&self) -> &String

Gets the error log directory name.

§Returns
  • &String - Reference to the error log directory name.
Source

pub fn set_path<P: AsRef<str>>(&mut self, path: P) -> &mut Self

Sets the log file storage path.

§Arguments
  • P: AsRef<str> - The new path for storing log files, which will be converted to string slice.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_limit_file_size(&mut self, limit_file_size: usize) -> &mut Self

Sets the maximum size limit for log files.

§Arguments
  • usize - The new maximum file size limit in bytes.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_trace_dir<P: AsRef<str>>(&mut self, dir: P) -> &mut Self

Sets the trace log directory name.

§Arguments
  • P: AsRef<str> - The directory name for trace logs.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_debug_dir<P: AsRef<str>>(&mut self, dir: P) -> &mut Self

Sets the debug log directory name.

§Arguments
  • P: AsRef<str> - The directory name for debug logs.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_info_dir<P: AsRef<str>>(&mut self, dir: P) -> &mut Self

Sets the info log directory name.

§Arguments
  • P: AsRef<str> - The directory name for info logs.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_warn_dir<P: AsRef<str>>(&mut self, dir: P) -> &mut Self

Sets the warn log directory name.

§Arguments
  • P: AsRef<str> - The directory name for warn logs.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn set_error_dir<P: AsRef<str>>(&mut self, dir: P) -> &mut Self

Sets the error log directory name.

§Arguments
  • P: AsRef<str> - The directory name for error logs.
§Returns
  • &mut Self - Mutable reference to self for method chaining.
Source

pub fn is_enable(&self) -> bool

Checks if logging is enabled.

§Returns
  • bool - True if logging is enabled.
Source

pub fn is_disable(&self) -> bool

Checks if logging is disabled.

§Returns
  • bool - True if logging is disabled.
Source

pub fn trace<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs trace message synchronously.

§Arguments
  • AsRef<str> - Trace data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub async fn async_trace<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs trace message asynchronously.

§Arguments
  • AsRef<str> - Trace data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub fn debug<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs debug message synchronously.

§Arguments
  • AsRef<str> - Debug data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub async fn async_debug<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs debug message asynchronously.

§Arguments
  • AsRef<str> - Debug data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub fn info<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs info message synchronously.

§Arguments
  • AsRef<str> - Info data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub async fn async_info<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs info message asynchronously.

§Arguments
  • AsRef<str> - Info data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub fn warn<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs warn message synchronously.

§Arguments
  • AsRef<str> - Warn data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub async fn async_warn<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs warn message asynchronously.

§Arguments
  • AsRef<str> - Warn data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub fn error<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs error message synchronously.

§Arguments
  • AsRef<str> - Error data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.
Source

pub async fn async_error<T, L>(&self, data: T, func: L) -> &Self
where T: AsRef<str>, L: FileLoggerFuncTrait<T>,

Logs error message asynchronously.

§Arguments
  • AsRef<str> - Error data to be logged, which will be converted to string slice.
  • L: FileLoggerFuncTrait<T> - FileLogger formatting function.
§Returns
  • &Self - Reference to self.

Trait Implementations§

Source§

impl Clone for FileLogger

Source§

fn clone(&self) -> FileLogger

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for FileLogger

Default implementation for FileLogger configuration.

Source§

fn default() -> Self

Creates default FileLogger configuration.

§Returns
  • Self - Default FileLogger instance with default path and file size limit.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.