[go: up one dir, main page]

duplicate 2.0.1

Provides macros for duplication of code with variable substitution.
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

use proc_macro::Span;
#[cfg(feature = "pretty_errors")]
use proc_macro2::Span as Span2;
#[cfg(feature = "pretty_errors")]
use proc_macro2_diagnostics::{Diagnostic, Level};

/// Used to report errors.
///
/// When 'pretty_errors' isn't enabled, simply includes a basic message.
/// When enabled, adds a span for the source of the error and a more detailed
/// and helpful message we call hint.
#[derive(Debug)]
pub struct Error
{
	/// Basic error message.
	///
	/// Will always be reported (first).
	msg: String,

	/// The source of the error
	#[cfg(feature = "pretty_errors")]
	span: Span,

	/// Additional error details and help
	#[cfg(feature = "pretty_errors")]
	hint: String,
}

impl Error
{
	/// Creates a basic error.
	pub fn new(msg: impl Into<String>) -> Self
	{
		#[cfg(feature = "pretty_errors")]
		{
			Self {
				msg: msg.into(),
				span: Span::call_site(),
				hint: "".to_string(),
			}
		}
		#[cfg(not(feature = "pretty_errors"))]
		{
			Self { msg: msg.into() }
		}
	}

	/// Adds a span to the error and returns it.
	///
	/// If `pretty_errors` is disabled, does nothing.
	#[allow(unused_variables)]
	#[allow(unused_mut)]
	pub fn span(mut self, span: Span) -> Self
	{
		#[cfg(feature = "pretty_errors")]
		{
			self.span = span;
		}
		self
	}

	/// Adds a hint to the error and returns it.
	///
	/// If `pretty_errors` is disabled, does nothing.
	#[allow(unused_variables)]
	#[allow(unused_mut)]
	pub fn hint(mut self, hint: impl Into<String>) -> Self
	{
		#[cfg(feature = "pretty_errors")]
		{
			self.hint = hint.into();
		}
		self
	}

	/// Returns the source span of the error
	/// (or a stub value if the `pretty_errors` feature is disabled).
	pub fn get_span(&self) -> Span
	{
		#[cfg(feature = "pretty_errors")]
		{
			self.span
		}
		#[cfg(not(feature = "pretty_errors"))]
		{
			Span::call_site()
		}
	}

	/// Returns the message of the error.
	#[cfg(not(feature = "pretty_errors"))]
	pub fn into_panic_message(self) -> String
	{
		self.msg
	}

	#[cfg(feature = "pretty_errors")]
	/// Converts the error into a [`Diagnostic`] ready for emitting.
	pub fn into_diagnostic(self) -> Diagnostic
	{
		let mut diagnostic = Diagnostic::spanned(Span2::from(self.span), Level::Error, self.msg);
		if !self.hint.is_empty()
		{
			diagnostic = diagnostic.help(self.hint);
		}
		diagnostic
	}
}