Struct Author 

pub struct Author { /* private fields */ }

The author or creator of the message.

The base author will contain the hostname of the OS that sent to message. This helps identify which machine the message came from. If this is not available then ‘?’ will be used.

A good author should allow the user to quickly and easily identify where the message originates from. To make a good author, think, could you quickly and easily stop the source of the messages just based on the author?

Filtering should not be performed based on an Author, rather you should filter instead based on Level and Component

Implementations

impl Author

pub fn parse(parts: String) -> Author

Parses an Author from the given string.

// A good Author for a message originating from the db_checker program
// which is invoked by user's crontab.
use rnotifylib::message::author::Author;

let author = Author::parse("user/cron/db_checker".to_owned());

pub fn base() -> Author

Provides the base Author, of either the hostname. If the hostname cannot be found, uses base_incognito

pub fn base_incognito() -> Author

Creates an Author with an unknown hostname. You should use base whenever possible, but if you do not want to expose the hostname of the sender, you can use this method.

pub fn parse_incognito(s: String) -> Author

Parses an author, using an unknown hostname You should use parse whenever possible, but if you do not want to expose the hostname of the sender, you can use this method.

pub fn extend(&mut self, parts: String)

Adds more information to the author of this

use rnotifylib::message::author::Author;

// Normally you should use Author::base(), but we want predictable output for this test.
let mut author = Author::base_incognito();
author.extend("user".to_owned());
author.extend("cron".to_owned());
author.extend("db_checker".to_owned());

assert_eq!(author.to_string(), "?/user/cron/db_checker");

Trait Implementations

impl Clone for Author

fn clone(&self) -> Author

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Author

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

Formats the value using the given formatter.

impl Display for Author

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

Formats the value using the given formatter.

impl PartialEq for Author

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