Struct murmur::Whisper

pub struct Whisper {
    pub icon_kind: Option<IconKind>,
    pub messages: Vec<String>,
}

Represents a collection of messages with an optional icon and message

Fields

• icon_kind - An optional field that specifies the kind of icon to be displayed.
• messages - A vector of messages to be displayed.

Example

use murmur::{Whisper, IconKind};

let whisper = Whisper::new()
    .icon(IconKind::NfFaBug)
    .message("test_whisper_unwrap")
    .whisper()
    .ok();

Fields

icon_kind: Option<IconKind>

An optional field that specifies the kind of icon to be displayed.

messages: Vec<String>

A vector of messages to be displayed.

Implementations

impl Whisper

pub fn new() -> Self

Creates a new Whisper instance.

Example

use murmur::{Whisper, IconKind};

let whisper = Whisper::new()
    .icon(IconKind::NfFaBug)
    .message("message")
    .whisper()
    .ok();

pub fn icon(self, icon_kind: IconKind) -> Self

Adds an icon to the Whisper instance.

Arguments

• icon_kind: The kind of icon to be displayed. See the IconKind enum for a list of available icons.

Returns

A Whisper instance with the specified icon.

Examples

use murmur::{Whisper, IconKind};
let whisper = Whisper::new()
    .icon(IconKind::NfFaCheck)
    .message("Nerd Font icons if you have them installed")
    .message("Another message")
    .whisper()
    .expect("Failed to print message");

let whisper = Whisper::new()
    .icon(IconKind::UnicodeWarningSign)
    .message("Unicode icons")
    .whisper()
    .or_else(|err| Err(err));

pub fn message<T: Display + Debug>(self, message: T) -> Self

Adds a single message to the Whisper instance.

Arguments

• message: The message to be added.

Returns

A Whisper instance with the added message.

Example

use murmur::Whisper;
let whisper = Whisper::new()
   .message("1 message without icon")
   .message("2 message")
   .message("3 message")
   .whisper()
   .ok();

Output

1 message without icon
  2 message without icon indents by 2 spaces all messages after the first
  3 message

pub fn messages<I, S>(self, messages: I) -> Self

where I: IntoIterator<Item = S>, S: Display + Debug + AsRef<str>,

Adds multiple messages to the Whisper instance.

Arguments

• messages: An iterable collection of items, each implementing Display, Debug, and AsRef<str>.

Returns a Whisper instance with the added messages.

Examples

use murmur::Whisper;

Whisper::new()
    .messages(["1 message", "2 message", "3 message"])
    .whisper()
    .ok();

Whisper::new()
    .messages(vec!["1 message", "2 message", "3 message"])
    .whisper()
    .ok();

Output

1 message
  2 message
  3 message

pub fn whisper(&self) -> Result<(), WhisperError>

The whisper function is responsible for building the Whisper instance and printing the messages. It performs several steps to ensure the messages are printed correctly:

1. It first tries to lock the ICON_MAP to safely access the global variable in a concurrent environment.
2. If the lock is successfully acquired, it checks the icon_kind field of the Whisper instance.
3. If icon_kind is Some, it tries to get the corresponding icon and color from the icon_map.
4. If icon_kind is None or if the icon_kind does not exist in the icon_map, it defaults to an empty string for both icon and color.
5. Finally, it prints the messages with the specified color and an optional icon prefix.

Returns

This function returns a Result. If the operation is successful, it returns Ok(()). If there is an error during the operation, it returns WhisperError.

Errors

This function will return WhisperError::Lock if it fails to acquire a lock on the ICON_MAP. It will return WhisperError::Print if there is an error while printing the messages.

Example

use murmur::{Whisper, IconKind};
use std::io::{Error, ErrorKind};

fn main() -> Result<(), Error> {
    let whisper = Whisper::new()
        .icon(IconKind::NfFaBug)
       .message("test_whisper_unwrap")
       .whisper()
       .map_err(|err| Error::new(ErrorKind::Other, err))?;
    Ok(())
}

Trait Implementations

impl Clone for Whisper

fn clone(&self) -> Whisper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Whisper

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

Formats the value using the given formatter.

impl Default for Whisper

fn default() -> Whisper

Returns the “default value” for a type.

impl PartialEq for Whisper

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

impl StructuralEq for Whisper

impl StructuralPartialEq for Whisper