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

# Enum core::ops::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:

    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));Run

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());Run

## 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> Clone for Bound<T>`

[src]

####

`fn clone(&self) -> Bound<T>`

[src]

Returns a copy of the value. Read more

####

`fn clone_from(&mut self, source: &Self)`

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl<T: Copy> Copy for Bound<T>`

[src]

###

`impl<T: Debug> Debug for Bound<T>`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl<T: Hash> Hash for Bound<T>`

[src]

####

`fn hash<__HT: Hasher>(&self, state: &mut __HT)`

[src]

Feeds this value into the given [`Hasher`]. Read more

####

`fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where Self: Sized,`

1.3.0
[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

###

`impl<T: PartialEq> PartialEq for Bound<T>`

[src]

####

`fn eq(&self, other: &Bound<T>) -> bool`

[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

####

`fn ne(&self, other: &Bound<T>) -> bool`

[src]

This method tests for `!=`.

###

`impl<T: Eq> Eq for Bound<T>`

[src]

## Auto Trait Implementations

###

`impl<T> Send for Bound<T> where T: Send,`

###

`impl<T> Sync for Bound<T> where T: Sync,`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)