Struct Log

pub struct Log {
    pub session_id: String,
    pub time: String,
    pub level: LogLevel,
    pub component: String,
    pub description: String,
    pub format: LogFormat,
}

The Log struct provides an easy way to log a message to the console. It contains a set of defined fields to create a simple log message with a readable output format.

Fields

session_id: String

The session ID for the log entry.

time: String

The time the log entry was created.

level: LogLevel

The log level of the message.

component: String

The component that generated the log message.

description: String

The description of the log message.

format: LogFormat

The format of the log message.

Implementations

impl Log

pub async fn log(&self) -> RlgResult<()>

Logs a message asynchronously using a pre-allocated buffer to reduce memory allocation.

This function formats the log message according to the specified log format and writes it to both the log file and standard output. It ensures that the log file is flushed after every write to guarantee data persistence.

Returns

• RlgResult<()> - Result with Ok(()) if the logging succeeds, or RlgError if any errors occur.

pub fn new( session_id: &str, time: &str, level: &LogLevel, component: &str, description: &str, format: &LogFormat, ) -> Self

Creates a new log entry with provided details.

pub async fn write_log_entry( log_level: LogLevel, process: &str, message: &str, log_format: LogFormat, ) -> RlgResult<()>

Writes a log entry to the log file using the provided details.

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Log

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

Formats the value using the given formatter.

impl Default for Log

fn default() -> Log

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Log

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Log

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

Formats the value using the given formatter.

impl Hash for Log

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 PartialEq for Log

fn eq(&self, other: &Log) -> 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 Log

fn partial_cmp(&self, other: &Log) -> 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 Serialize for Log

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Log

impl StructuralPartialEq for Log