locspan 0.8.2

Code mapping utility types and traits.
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use crate::{Location, Meta, Span};

/// Data with `Location` metadata.
///
/// This type alias is provided with a constructor function of the same name
/// so it is possible to build `Loc` values with `Loc(value, location)`.
pub type Loc<T, F, S = Span> = Meta<T, Location<F, S>>;

/// Build a data with `Location` metadata.
#[allow(non_snake_case)]
#[doc(hidden)]
#[inline(always)]
pub fn Loc<T, F, S>(t: T, location: Location<F, S>) -> Loc<T, F, S> {
	Meta(t, location)
}

impl<T, F, S> Loc<T, F, S> {
	/// Discards the value and returns its location.
	pub fn into_location(self) -> Location<F, S> {
		self.into_metadata()
	}

	/// Discards the value and returns its file.
	#[inline(always)]
	pub fn into_file(self) -> F {
		self.1.into_file()
	}

	/// Discards the value and returns its span.
	#[inline(always)]
	pub fn into_span(self) -> S {
		self.1.into_span()
	}

	/// Returns a reference to the value's location.
	#[inline(always)]
	pub fn location(&self) -> &Location<F, S> {
		self.metadata()
	}

	/// Returns a mutable reference to the value's location.
	#[inline(always)]
	pub fn location_mut(&mut self) -> &mut Location<F, S> {
		self.metadata_mut()
	}

	/// Returns the value's span.
	#[inline(always)]
	pub fn span(&self) -> S
	where
		S: Clone,
	{
		self.1.span()
	}

	/// Returns a mutable reference the value's span.
	#[inline(always)]
	pub fn span_mut(&mut self) -> &mut S {
		self.1.span_mut()
	}

	/// Sets the value's span and returns the previous one.
	#[inline(always)]
	pub fn set_span(&mut self, span: S) -> S {
		self.1.set_span(span)
	}

	/// Returns a reference to the value's source file.
	#[inline(always)]
	pub fn file(&self) -> &F {
		self.1.file()
	}

	/// Returns a mutable reference to the value's source file.
	#[inline(always)]
	pub fn file_mut(&mut self) -> &mut F {
		self.1.file_mut()
	}

	/// Sets the value's file and returns the previous one.
	#[inline(always)]
	pub fn set_file(&mut self, file: F) -> F {
		self.1.set_file(file)
	}

	/// Maps the value's location.
	#[inline(always)]
	pub fn map_location<G, U>(
		self,
		f: impl FnOnce(Location<F, S>) -> Location<G, U>,
	) -> Loc<T, G, U> {
		Loc(self.0, f(self.1))
	}

	/// Maps the value's location's file.
	#[inline(always)]
	pub fn map_file<G>(self, f: impl FnOnce(F) -> G) -> Loc<T, G, S> {
		Loc(self.0, self.1.map_file(f))
	}

	/// Borrows the file and clones the value.
	#[inline(always)]
	pub fn borrow_value_and_file(&self) -> Loc<&T, &F, S>
	where
		T: Clone,
		S: Clone,
	{
		Loc(&self.0, self.1.borrow())
	}

	/// Borrows the file and clones the value.
	#[inline(always)]
	pub fn borrow_file(&self) -> Loc<T, &F, S>
	where
		T: Clone,
		S: Clone,
	{
		Meta(self.0.clone(), self.1.borrow())
	}
}

impl<'f, T, F: Clone, S: Clone> Loc<T, &'f F, S> {
	/// Clones the value and the borrowed file to return a new `Loc<T, F>`.
	#[inline(always)]
	pub fn cloned_file(&self) -> Loc<T, F, S>
	where
		T: Clone,
	{
		Loc(self.0.clone(), self.1.cloned())
	}

	/// Clones the borrowed file and consumes the value to return a new `Loc<T, F>`.
	#[inline(always)]
	pub fn into_cloned_file(self) -> Loc<T, F, S> {
		Loc(self.0, self.1.cloned())
	}
}

impl<'t, 'f, T: Clone, F: Clone, S: Clone> Loc<&'t T, &'f F, S> {
	/// Clones the borrowed value and file to return a new `Loc<T, F>`.
	pub fn cloned(&self) -> Loc<T, F, S> {
		Loc(self.0.clone(), self.1.cloned())
	}
}