Struct rnotifylib::message::Message

pub struct Message { /* private fields */ }

A Message represents a MessageDestination independent way to send a message to a platform. However - not every destination will support every type of formatting, or may have length / size restrictions - so be aware of this. Destinations should do their best to receive the message, even if they have to ignore formatting to do so.

To construct a Message, consider using MessageBuilder or MessageDetailBuilder to make your life easier.

Parts of a Message

• Level - Severity of message
• Title - Optional, short snappy summary of what the message is about
• MessageDetail - Structured body text supporting formatting
• Component - Optional, indicating what the message is about, e.g a program or server.
• Author - Who created the message
• Timestamp - The unix timestamp in milliseconds, showing when the message was sent.

Implementations

impl Message

pub fn new(
    level: Level,
    title: Option<String>,
    message_detail: MessageDetail,
    component: Option<Component>,
    author: Author,
    unix_timestamp_millis: i64
) -> Self

pub fn get_level(&self) -> &Level

pub fn get_title(&self) -> &Option<String>

pub fn get_message_detail(&self) -> &MessageDetail

pub fn get_unix_timestamp_millis(&self) -> i64

pub fn get_author(&self) -> &Author

pub fn get_component(&self) -> &Option<Component>

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq<Message> for Message

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Message