Log

hyperlane_utils

Struct Log

pub struct Log { /* private fields */ }

Expand description

Main configuration structure for log file output.

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

Implementations§

impl Log

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

Creates new Log 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 Log instance with specified configuration.

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

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.

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

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.

pub fn is_enable(&self) -> bool

Checks if logging is enabled.

§Returns

bool - True if logging is enabled.

pub fn is_disable(&self) -> bool

Checks if logging is disabled.

§Returns

bool - True if logging is disabled.

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

Logs error message synchronously.

§Arguments

AsRef<str> - Error data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

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

Logs error message asynchronously.

§Arguments

AsRef<str> - Error data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

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

Logs info message synchronously.

§Arguments

AsRef<str> - Info data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

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

Logs info message asynchronously.

§Arguments

AsRef<str> - Info data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

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

Logs debug message synchronously.

§Arguments

AsRef<str> - Debug data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

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

Logs debug message asynchronously.

§Arguments

AsRef<str> - Debug data to be logged, which will be converted to string slice.
L: LogFuncTrait<T> - Log formatting function.

§Returns

&Self - Reference to self.

Trait Implementations§

impl Clone for Log

fn clone(&self) -> Log

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

impl Default for Log

Default implementation for Log configuration.

fn default() -> Log

Creates default Log configuration.

§Returns

Self - Default Log instance with default path and file size limit.

Auto Trait Implementations§

impl Freeze for Log

impl RefUnwindSafe for Log

impl Send for Log

impl Sync for Log

impl Unpin for Log

impl UnwindSafe for Log

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> AnySend for T
where T: Any + Send,

impl<T> AnySendClone for T
where T: Any + Send + Clone,

impl<T> AnySendSync for T
where T: Any + Send + Sync,

impl<T> AnySendSyncClone for T
where T: Any + Send + Sync + Clone,

impl<T> AnySync for T
where T: Any + Sync,

impl<T> AnySyncClone for T
where T: Any + Sync + Clone,

impl<T> ErasedDestructor for T
where T: 'static,