std::cmp::Reverse - Rust
Description: API documentation for the Rust `Reverse` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Reverse

# Struct std::cmp::Reverse 1.19.0 [−] [src]

    pub struct Reverse<T>(pub T);

A helper struct for reverse ordering.

This struct is a helper to be used with functions like `Vec::sort_by_key` and can be used to reverse order a part of a key.

Example usage:

    use std::cmp::Reverse;

    let mut v = vec![1, 2, 3, 4, 5, 6];
    v.sort_by_key(|&num| (num > 3, Reverse(num)));
    assert_eq!(v, vec![3, 2, 1, 6, 5, 4]);Run

## Trait Implementations

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

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

Formats the value using the given formatter.

### `impl<T> PartialOrd<Reverse<T>> for Reverse<T> where
T: PartialOrd<T>,`
[src]

#### `fn partial_cmp(&self, other: &Reverse<T>) -> Option<Ordering>`

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Reverse<T>) -> bool`

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Reverse<T>) -> bool`

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn ge(&self, other: &Reverse<T>) -> bool`

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

#### `fn gt(&self, other: &Reverse<T>) -> bool`

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

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

### `impl<T> Ord for Reverse<T> where
T: Ord,`
[src]

#### `fn cmp(&self, other: &Reverse<T>) -> Ordering`

This method returns an `Ordering` between `self` and `other`. Read more

#### `fn max(self, other: Self) -> Self`

🔬 This is a nightly-only experimental API. (`ord_max_min` #25663)

Compares and returns the maximum of two values. Read more

#### `fn min(self, other: Self) -> Self`

🔬 This is a nightly-only experimental API. (`ord_max_min` #25663)

Compares and returns the minimum of two values. Read more

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

#### `fn eq(&self, __arg_0: &Reverse<T>) -> bool`

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

#### `fn ne(&self, __arg_0: &Reverse<T>) -> bool`

This method tests for `!=`.

# 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`)