gix-error 0.2.1

A crate of the gitoxide project to provide common errors and error-handling utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use std::borrow::Cow;
use std::fmt::{Debug, Display, Formatter};

/// An error that is further described in a message.
#[derive(Debug)]
pub struct Message(
    /// The error message.
    pub(crate) Cow<'static, str>,
);

/// Lifecycle
impl Message {
    /// Create a new instance that displays the given `message`.
    pub fn new(message: impl Into<Cow<'static, str>>) -> Self {
        Message(message.into())
    }
}

impl Display for Message {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.0.as_ref())
    }
}

impl std::error::Error for Message {}

impl From<String> for Message {
    fn from(msg: String) -> Self {
        Message::new(msg)
    }
}

impl From<&'static str> for Message {
    fn from(msg: &'static str) -> Self {
        Message::new(msg)
    }
}

/// Return a new statically allocated `message`.
///
/// Use the [message!-macro](crate::message!) for convenient `format!`-like behavior.
pub fn message(message: &'static str) -> Message {
    Message::new(message)
}