Enum LogFormat

#[non_exhaustive]
pub enum LogFormat {
    CLF,
    JSON,
    CEF,
    ELF,
    W3C,
    GELF,
    ApacheAccessLog,
    Logstash,
    Log4jXML,
    NDJSON,
}

An enumeration of the different log formats that can be used.

Variants

• CLF - Common Log Format.
• JSON - JavaScript Object Notation.
• CEF - Common Event Format.
• ELF - Extended Log Format.
• W3C - W3C Extended Log File Format.
• GELF - Graylog Extended Log Format.
• ApacheAccessLog - Apache HTTP server access logs.
• Logstash - Logstash JSON format.
• Log4jXML - Log4j’s XML format.
• NDJSON - Newline Delimited JSON.

Examples

use rlg::log_format::LogFormat;
let format: LogFormat = "CLF".parse().unwrap();
assert_eq!(format, LogFormat::CLF);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CLF

Common Log Format.

JSON

JavaScript Object Notation.

CEF

Common Event Format.

ELF

Extended Log Format.

W3C

W3C Extended Log File Format.

GELF

Graylog Extended Log Format.

ApacheAccessLog

Apache HTTP server access logs.

Logstash

Logstash JSON format.

Log4jXML

Log4j’s XML format.

NDJSON

Newline Delimited JSON.

Implementations

impl LogFormat

pub fn validate(&self, input: &str) -> bool

Validates if a given string adheres to a particular log format.

Arguments

• input - A string slice that holds the log entry to be validated.

Returns

• bool - Returns true if the input matches the log format, false otherwise.

Example

use rlg::log_format::LogFormat;
let is_valid = LogFormat::CLF.validate("127.0.0.1 - - [10/Oct/2000:13:55:36 -0700] \"GET /apache_pb.gif HTTP/1.0\" 200 2326");
assert!(is_valid);

pub fn format_log(&self, entry: &str) -> RlgResult<String>

Formats a log entry according to the specified log format.

Arguments

• entry - A string slice that holds the log entry to be formatted.

Returns

A RlgResult<String> containing the formatted log entry or an error if the formatting fails.

Example

use rlg::log_format::LogFormat;
let formatted_log = LogFormat::CLF.format_log("127.0.0.1 - - [10/Oct/2000:13:55:36 -0700] \"GET /apache_pb.gif HTTP/1.0\" 200 2326").unwrap();

Trait Implementations

impl Clone for LogFormat

fn clone(&self) -> LogFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LogFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LogFormat

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

Formats the value using the given formatter.

impl FromStr for LogFormat

type Err = RlgError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for LogFormat

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 LogFormat

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for LogFormat

impl Eq for LogFormat

impl StructuralPartialEq for LogFormat