error_snippet 0.2.0

Library for reporting fancy diagnostics to the console
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use std::path::PathBuf;

use crate::Result;

/// Defines a source file, which can be used to provide context for diagnostics.
///
/// This trait represents some sort of source code, which will be reported to the user as
/// part of the reporting process.
pub trait Source: Send + Sync + std::fmt::Debug {
    /// Defines the name of the source file.
    fn name(&self) -> Option<&str> {
        None
    }

    /// Gets the full content of the source file.
    fn content(&self) -> Box<&str>;
}

impl Source for [u8] {
    fn content(&self) -> Box<&str> {
        Box::new(std::str::from_utf8(self).unwrap())
    }
}

impl Source for &[u8] {
    fn content(&self) -> Box<&str> {
        <[u8] as Source>::content(self)
    }
}

impl Source for Vec<u8> {
    fn content(&self) -> Box<&str> {
        <[u8] as Source>::content(self)
    }
}

impl Source for str {
    fn content(&self) -> Box<&str> {
        <[u8] as Source>::content(self.as_bytes())
    }
}

impl Source for &str {
    fn content(&self) -> Box<&str> {
        <str as Source>::content(self)
    }
}

impl Source for String {
    fn content(&self) -> Box<&str> {
        <str as Source>::content(self)
    }
}

impl Source for &String {
    fn content(&self) -> Box<&str> {
        <String as Source>::content(self)
    }
}

/// Represents a simple source with only string-based content.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StringSource {
    /// Defines the content of the source file.
    pub content: String,
}

impl StringSource {
    /// Creates a new [`StringSource`] from the content.
    pub fn new(content: String) -> Self {
        Self { content }
    }
}

impl Source for StringSource {
    fn name(&self) -> Option<&str> {
        None
    }

    fn content(&self) -> Box<&str> {
        Box::new(self.content.as_str())
    }
}

/// Represents a source file with a name and content.
///
/// This is the default implementation of the [`Source`] trait and is used
/// internally to create diagnostics using derive-macros.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NamedSource {
    /// Defines the name of the source file.
    pub name: String,

    /// Defines the content of the source file.
    pub content: String,
}

impl NamedSource {
    /// Creates a new [`NamedSource`] from the given name and content.
    pub fn new(name: impl Into<String>, content: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            content: content.into(),
        }
    }

    /// Creates a new [`NamedSource`] instance from an existing file.
    pub fn from_file(path: PathBuf) -> Result<NamedSource> {
        let name = path.to_string_lossy().to_string();
        let content = std::fs::read_to_string(path)?;

        Ok(NamedSource { name, content })
    }
}

impl Source for NamedSource {
    fn name(&self) -> Option<&str> {
        Some(self.name.as_str())
    }

    fn content(&self) -> Box<&str> {
        Box::new(self.content.as_str())
    }
}