pub enum Bound<T> {
Included(T),
Excluded(T),
Unbounded,
}
Expand description
An endpoint of a range of keys.
Examples
Bound
s are range endpoints:
use std::ops::Bound::*;
use std::ops::RangeBounds;
assert_eq!((..100).start_bound(), Unbounded);
assert_eq!((1..12).start_bound(), Included(&1));
assert_eq!((1..12).end_bound(), Excluded(&12));
Using a tuple of Bound
s as an argument to BTreeMap::range
.
Note that in most cases, it’s better to use range syntax (1..5
) instead.
use std::collections::BTreeMap;
use std::ops::Bound::{Excluded, Included, Unbounded};
let mut map = BTreeMap::new();
map.insert(3, "a");
map.insert(5, "b");
map.insert(8, "c");
for (key, value) in map.range((Excluded(3), Included(8))) {
println!("{key}: {value}");
}
assert_eq!(Some((&3, &"a")), map.range((Unbounded, Included(5))).next());
Variants
Included(T)
An inclusive bound.
Excluded(T)
An exclusive bound.
Unbounded
An infinite endpoint. Indicates that there is no bound in this direction.
Implementations
sourceimpl<T> Bound<T>
impl<T> Bound<T>
sourcepub fn as_ref(&self) -> Bound<&T>
🔬 This is a nightly-only experimental API. (bound_as_ref
)
pub fn as_ref(&self) -> Bound<&T>
bound_as_ref
)Converts from &Bound<T>
to Bound<&T>
.
sourcepub fn as_mut(&mut self) -> Bound<&mut T>
🔬 This is a nightly-only experimental API. (bound_as_ref
)
pub fn as_mut(&mut self) -> Bound<&mut T>
bound_as_ref
)Converts from &mut Bound<T>
to Bound<&mut T>
.
sourcepub fn map<U, F>(self, f: F) -> Bound<U> where
F: FnOnce(T) -> U,
🔬 This is a nightly-only experimental API. (bound_map
)
pub fn map<U, F>(self, f: F) -> Bound<U> where
F: FnOnce(T) -> U,
bound_map
)Maps a Bound<T>
to a Bound<U>
by applying a function to the contained value (including
both Included
and Excluded
), returning a Bound
of the same kind.
Examples
#![feature(bound_map)]
use std::ops::Bound::*;
let bound_string = Included("Hello, World!");
assert_eq!(bound_string.map(|s| s.len()), Included(13));
#![feature(bound_map)]
use std::ops::Bound;
use Bound::*;
let unbounded_string: Bound<String> = Unbounded;
assert_eq!(unbounded_string.map(|s| s.len()), Unbounded);
Trait Implementations
sourceimpl<'de, T> Deserialize<'de> for Bound<T> where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for Bound<T> where
T: Deserialize<'de>,
sourcefn deserialize<D>(
deserializer: D
) -> Result<Bound<T>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Bound<T>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<T> Serialize for Bound<T> where
T: Serialize,
impl<T> Serialize for Bound<T> where
T: Serialize,
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<T> Copy for Bound<T> where
T: Copy,
impl<T> Eq for Bound<T> where
T: Eq,
impl<T> StructuralEq for Bound<T>
impl<T> StructuralPartialEq for Bound<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Bound<T> where
T: RefUnwindSafe,
impl<T> Send for Bound<T> where
T: Send,
impl<T> Sync for Bound<T> where
T: Sync,
impl<T> Unpin for Bound<T> where
T: Unpin,
impl<T> UnwindSafe for Bound<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more