Struct gelf::Message

pub struct Message<'a> { /* fields omitted */ }

Message is thre representation of a GELF message.

Message provides a fluid setter and getter interface to all of GELF's features. Only the host-field is not available. It is managed the Logger.

A Message can also be constructed from a log::LogRecord. All available metadata is transferred over to the message object.

Methods

impl<'a> Message<'a>

pub fn new<S>(short_message: S) -> Self where
    S: Into<Cow<'a, str>> + AsRef<str>, 

Construct a new log message.

All fields will use their defaults. This means usually Option::None. A notable exception is level. The GELF spec requires this field to default to Level::Alert.

pub fn new_with_level<S>(short_message: S, level: Level) -> Self where
    S: Into<Cow<'a, str>> + AsRef<str>, 

Construct a new log message with a defined level

All fields will use their defaults. This means usually Option::None.

pub fn short_message(&self) -> &Cow<'a, str>

Return the short_message

pub fn set_short_message<S>(&mut self, msg: S) -> &mut Self where
    S: Into<Cow<'a, str>> + AsRef<str>, 

Set the short_message

pub fn full_message(&self) -> &Option<Cow<'a, str>>

Return the full_message

pub fn set_full_message<S>(&mut self, msg: S) -> &mut Self where
    S: Into<Cow<'a, str>> + AsRef<str>, 

Set the full_message

pub fn clear_full_message(&mut self) -> &mut Self

pub fn timestamp(&self) -> &Option<DateTime<Utc>>

Return the timestamp

pub fn set_timestamp(&mut self, ts: DateTime<Utc>) -> &mut Self

Set the timestamp

pub fn clear_timestamp(&mut self) -> &mut Self

Clear the timestamp

pub fn level(&self) -> Level

Return the level

pub fn set_level(&mut self, level: Level) -> &mut Self

Set the level

pub fn metadata(&self, key: &'a str) -> Option<&Cow<'a, str>>

Return a metadata field with given key

pub fn all_metadata(&self) -> &HashMap<Cow<'a, str>, Cow<'a, str>>

Return all metadata

pub fn set_metadata<S, T>(&mut self, key: S, value: T) -> Result<&mut Self> where
    S: Into<Cow<'a, str>> + AsRef<str>,
    T: Into<Cow<'a, str>> + AsRef<str>, 

Set a metadata field with given key to value

Trait Implementations

impl<'a> Clone for Message<'a>

fn clone(&self) -> Message<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Message<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Message<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Record<'a>> for Message<'a>

fn from(record: &'a Record) -> Message<'a>

Create a Message from given log::LogRecord including all metadata

impl<'a> PartialEq<Message<'a>> for Message<'a>

fn eq(&self, other: &Message<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Message<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Message<'a>