collections::Bound - Rust
Description: API documentation for the Rust `Bound` enum in crate `collections`.
Keywords: rust, rustlang, rust-lang, Bound

# Enum collections::Bound 1.17.0 [−] [src]

    pub enum Bound<T> {
        Included(T),
        Excluded(T),
        Unbounded,
    }

An endpoint of a range of keys.

# Examples

`Bound`s are range endpoints:

    #![feature(collections_range)]

    use std::collections::range::RangeArgument;
    use std::collections::Bound::*;

    assert_eq!((..100).start(), Unbounded);
    assert_eq!((1..12).start(), Included(&1));
    assert_eq!((1..12).end(), 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::collections::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.

## Trait Implementations

### `impl<T> Clone for Bound<T> where
T: Clone,`
[src]

#### `fn clone(&self) -> Bound<T>`
[src]

### `impl<T> Eq for Bound<T> where
T: Eq,`
[src]

### `impl<T> Copy for Bound<T> where
T: Copy,`
[src]

### `impl<T> Hash for Bound<T> where
T: Hash,`
[src]

#### `fn hash<__HT>(&self, __arg_0: &mut __HT) where
__HT: Hasher,`
[src]

### `impl<T> PartialEq<Bound<T>> for Bound<T> where
T: PartialEq<T>,`
[src]

#### `fn eq(&self, __arg_0: &Bound<T>) -> bool`
[src]

#### `fn ne(&self, __arg_0: &Bound<T>) -> bool`
[src]

### `impl<T> Debug for Bound<T> where
T: Debug,`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)