gnaw 0.0.2

Conveniently chip small pieces off a slice or `str` to use elsewhere.
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

//! With this crate, you can conveniently chip pieces off a [slice] or [`str`] to use elsewhere.
//!
//! [slice]: https://doc.rust-lang.org/stable/std/primitive.slice.html
//! [`str`]: https://doc.rust-lang.org/stable/std/primitive.str.html
//!
//! # Example
//!
//! ```rust
//! use gnaw::{Drain as _, Pop as _, Unshift as _};
//!
//! let mut text = "abcdefg";
//!
//! assert_eq!(text.unshift(), Some('a'));
//! assert_eq!(text.pop(), Some('g'));
//!
//! let mut drain = text.drain();
//! assert_eq!(drain.next(), Some('b'));
//! assert_eq!(drain.next(), Some('c'));
//! assert_eq!(drain.next_back(), Some('f'));
//! assert_eq!(drain.next_back(), Some('e'));
//! drop(drain);
//!
//! //TODO: Why isn't the mutable borrow released here?
//! //assert_eq!(text, "d");
//! ```

#![warn(clippy::pedantic)]
#![doc(html_root_url = "https://docs.rs/gnaw/0.0.2")]

#[cfg(doctest)]
pub mod readme {
	doc_comment::doctest!("../README.md");
}

mod drains;
use drains::{SliceDrain, StrDrain};

pub trait Drain<'a, T> {
	type Target: DoubleEndedIterator<Item = T> + 'a;
	fn drain(&'a mut self) -> Self::Target;
}

pub trait Pop<T> {
	fn pop(&mut self) -> Option<T>;
}

pub trait Unshift<T> {
	fn unshift(&mut self) -> Option<T>;
}

impl<'a, T: 'a> Drain<'a, &'a T> for &'a [T] {
	type Target = SliceDrain<'a, T>;
	fn drain(&'a mut self) -> Self::Target {
		SliceDrain(self)
	}
}

// TODO
// impl<'a, T: 'a> Drain<'a, &'a mut T> for &'a mut [T] {
//     type Target = MutSliceDrain<'a, T>;
//     fn drain(&'a mut self) -> Self::Target {
//         MutSliceDrain(self)
//     }
// }

impl<'a> Drain<'a, char> for &'a str {
	type Target = StrDrain<'a>;
	fn drain(&'a mut self) -> Self::Target {
		StrDrain(self)
	}
}

// TODO: This method doesn't compile as-is, but there should be a way to do this.
// impl<'a, T> Pop<&'a mut T> for &'a mut [T] {
//     fn pop(&mut self) -> Option<&'a mut T> {
//         self.split_last_mut().map(|(t, rest)| -> &'a mut T {
//             *self = rest;
//             t
//         })
//     }
// }

impl<'a, T> Pop<&'a T> for &'a [T] {
	fn pop(&mut self) -> Option<&'a T> {
		self.split_last().map(|(t, rest)| {
			*self = rest;
			t
		})
	}
}

impl Pop<char> for &str {
	fn pop(&mut self) -> Option<char> {
		let c = self.chars().last();
		if let Some(c) = c {
			*self = &self[..self.len() - c.len_utf8()];
		}
		c
	}
}

// TODO: This method doesn't compile as-is, but there should be a way to do this.
// impl<'a, T> Unshift<&'a mut T> for &'a mut [T] {
//     fn unshift(&mut self) -> Option<&'a mut T> {
//         self.split_first_mut().map(|(t, rest)| -> &'a mut T {
//             *self = rest;
//             t
//         })
//     }
// }

impl<'a, T> Unshift<&'a T> for &'a [T] {
	fn unshift(&mut self) -> Option<&'a T> {
		self.split_first().map(|(t, rest)| {
			*self = rest;
			t
		})
	}
}

impl Unshift<char> for &str {
	fn unshift(&mut self) -> Option<char> {
		let c = self.chars().next();
		if let Some(c) = c {
			*self = &self[c.len_utf8()..];
		}
		c
	}
}