std::ops::Sub - Rust
Description: API documentation for the Rust `Sub` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Sub

# Trait std::ops::Sub 1.0.0[−][src]

    #[lang = "sub"]
    pub trait Sub<RHS = Self> {
        type Output;
        #[must_use]
    fn sub(self, rhs: RHS) -> Self::Output;
    }

The subtraction operator `-`.

Note that `RHS` is `Self` by default, but this is not mandatory. For example, `std::time::SystemTime` implements `Sub<Duration>`, which permits operations of the form `SystemTime = SystemTime - Duration`.

# Examples

## `Sub`tractable points

    use std::ops::Sub;

    #[derive(Debug, PartialEq)]
    struct Point {
        x: i32,
        y: i32,
    }

    impl Sub for Point {
        type Output = Point;

        fn sub(self, other: Point) -> Point {
            Point {
                x: self.x - other.x,
                y: self.y - other.y,
            }
        }
    }

    assert_eq!(Point { x: 3, y: 3 } - Point { x: 2, y: 3 },
               Point { x: 1, y: 0 });Run

## Implementing `Sub` with generics

Here is an example of the same `Point` struct implementing the `Sub` trait using generics.

    use std::ops::Sub;

    #[derive(Debug, PartialEq)]
    struct Point<T> {
        x: T,
        y: T,
    }

    // Notice that the implementation uses the associated type `Output`.
    impl<T: Sub<Output=T>> Sub for Point<T> {
        type Output = Point<T>;

        fn sub(self, other: Point<T>) -> Point<T> {
            Point {
                x: self.x - other.x,
                y: self.y - other.y,
            }
        }
    }

    assert_eq!(Point { x: 2, y: 3 } - Point { x: 1, y: 0 },
               Point { x: 1, y: 3 });Run

## Associated Types

### `type Output`

The resulting type after applying the `-` operator.

## Required Methods

### `
#[must_use]
fn sub(self, rhs: RHS) -> Self::Output`

Performs the `-` operation.

## Implementors

- `impl<'a> Sub<isize> for &'a isize type Output = <isize as Sub<isize>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<usize>> for Wrapping<usize> type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output;` | [src]

- `impl<'a> Sub<&'a i128> for i128 type Output = <i128 as Sub<i128>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<u64>> for &'b Wrapping<u64> type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a isize> for &'b isize type Output = <isize as Sub<isize>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a usize> for &'b usize type Output = <usize as Sub<usize>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<u8>> for &'b Wrapping<u8> type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<usize>> for &'a Wrapping<usize> type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<i16>> for Wrapping<i16> type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output;` | [src]

- `impl<'a> Sub<&'a isize> for isize type Output = <isize as Sub<isize>>::Output;` | [src]

- `impl<'a> Sub<i8> for &'a i8 type Output = <i8 as Sub<i8>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<i128>> for Wrapping<i128> type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a u64> for &'b u64 type Output = <u64 as Sub<u64>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<i16>> for &'a Wrapping<i16> type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output;` | [src]

- `impl Sub<Wrapping<u8>> for Wrapping<u8> type Output = Wrapping<u8>;` | [src]

- `impl Sub<i8> for i8 type Output = i8;` | [src]

- `impl<'a> Sub<Wrapping<i32>> for &'a Wrapping<i32> type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output;` | [src]

- `impl Sub<isize> for isize type Output = isize;` | [src]

- `impl<'a> Sub<u16> for &'a u16 type Output = <u16 as Sub<u16>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<u32>> for Wrapping<u32> type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output;` | [src]

- `impl<'a> Sub<u8> for &'a u8 type Output = <u8 as Sub<u8>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<u32>> for &'a Wrapping<u32> type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<i32>> for &'b Wrapping<i32> type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output;` | [src]

- `impl Sub<Wrapping<i32>> for Wrapping<i32> type Output = Wrapping<i32>;` | [src]

- `impl<'a, 'b> Sub<&'a f32> for &'b f32 type Output = <f32 as Sub<f32>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a i128> for &'b i128 type Output = <i128 as Sub<i128>>::Output;` | [src]

- `impl<'a> Sub<&'a i64> for i64 type Output = <i64 as Sub<i64>>::Output;` | [src]

- `impl Sub<u128> for u128 type Output = u128;` | [src]

- `impl<'a> Sub<Wrapping<u64>> for &'a Wrapping<u64> type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output;` | [src]

- `impl Sub<Wrapping<i16>> for Wrapping<i16> type Output = Wrapping<i16>;` | [src]

- `impl<'a, 'b> Sub<&'a f64> for &'b f64 type Output = <f64 as Sub<f64>>::Output;` | [src]

- `impl<'a> Sub<u64> for &'a u64 type Output = <u64 as Sub<u64>>::Output;` | [src]

- `impl Sub<Wrapping<u64>> for Wrapping<u64> type Output = Wrapping<u64>;` | [src]

- `impl<'a> Sub<i32> for &'a i32 type Output = <i32 as Sub<i32>>::Output;` | [src]

- `impl<'a> Sub<f32> for &'a f32 type Output = <f32 as Sub<f32>>::Output;` | [src]

- `impl Sub<f64> for f64 type Output = f64;` | [src]

- `impl<'a> Sub<&'a u128> for u128 type Output = <u128 as Sub<u128>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<i32>> for Wrapping<i32> type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output;` | [src]

- `impl<'a> Sub<&'a i8> for i8 type Output = <i8 as Sub<i8>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<i16>> for &'b Wrapping<i16> type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output;` | [src]

- `impl Sub<i128> for i128 type Output = i128;` | [src]

- `impl Sub<Wrapping<u128>> for Wrapping<u128> type Output = Wrapping<u128>;` | [src]

- `impl<'a> Sub<Wrapping<i128>> for &'a Wrapping<i128> type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<u128>> for &'b Wrapping<u128> type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<i8>> for &'b Wrapping<i8> type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<i64>> for &'a Wrapping<i64> type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output;` | [src]

- `impl Sub<u8> for u8 type Output = u8;` | [src]

- `impl Sub<u64> for u64 type Output = u64;` | [src]

- `impl<'a, 'b> Sub<&'a u16> for &'b u16 type Output = <u16 as Sub<u16>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<u8>> for Wrapping<u8> type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<isize>> for Wrapping<isize> type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<u32>> for &'b Wrapping<u32> type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output;` | [src]

- `impl<'a> Sub<&'a u16> for u16 type Output = <u16 as Sub<u16>>::Output;` | [src]

- `impl Sub<i32> for i32 type Output = i32;` | [src]

- `impl Sub<u32> for u32 type Output = u32;` | [src]

- `impl Sub<i16> for i16 type Output = i16;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<u16>> for &'b Wrapping<u16> type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output;` | [src]

- `impl<'a> Sub<usize> for &'a usize type Output = <usize as Sub<usize>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a i16> for &'b i16 type Output = <i16 as Sub<i16>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<isize>> for &'b Wrapping<isize> type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<usize>> for &'b Wrapping<usize> type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<i8>> for &'a Wrapping<i8> type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output;` | [src]

- `impl<'a> Sub<&'a usize> for usize type Output = <usize as Sub<usize>>::Output;` | [src]

- `impl<'a> Sub<&'a u64> for u64 type Output = <u64 as Sub<u64>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a u32> for &'b u32 type Output = <u32 as Sub<u32>>::Output;` | [src]

- `impl Sub<Wrapping<u16>> for Wrapping<u16> type Output = Wrapping<u16>;` | [src]

- `impl<'a> Sub<&'a Wrapping<i8>> for Wrapping<i8> type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output;` | [src]

- `impl<'a> Sub<&'a i16> for i16 type Output = <i16 as Sub<i16>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<u16>> for &'a Wrapping<u16> type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<i64>> for Wrapping<i64> type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a u8> for &'b u8 type Output = <u8 as Sub<u8>>::Output;` | [src]

- `impl Sub<Wrapping<i8>> for Wrapping<i8> type Output = Wrapping<i8>;` | [src]

- `impl<'a> Sub<&'a u8> for u8 type Output = <u8 as Sub<u8>>::Output;` | [src]

- `impl Sub<Wrapping<u32>> for Wrapping<u32> type Output = Wrapping<u32>;` | [src]

- `impl<'a> Sub<&'a Wrapping<u128>> for Wrapping<u128> type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<u16>> for Wrapping<u16> type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output;` | [src]

- `impl Sub<f32> for f32 type Output = f32;` | [src]

- `impl<'a, 'b> Sub<&'a u128> for &'b u128 type Output = <u128 as Sub<u128>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<u8>> for &'a Wrapping<u8> type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output;` | [src]

- `impl Sub<Wrapping<usize>> for Wrapping<usize> type Output = Wrapping<usize>;` | [src]

- `impl Sub<Duration> for Duration type Output = Duration;` | [src]

- `impl<'a> Sub<i16> for &'a i16 type Output = <i16 as Sub<i16>>::Output;` | [src]

- `impl<'a> Sub<&'a i32> for i32 type Output = <i32 as Sub<i32>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<i64>> for &'b Wrapping<i64> type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output;` | [src]

- `impl<'a> Sub<u128> for &'a u128 type Output = <u128 as Sub<u128>>::Output;` | [src]

- `impl Sub<Wrapping<isize>> for Wrapping<isize> type Output = Wrapping<isize>;` | [src]

- `impl<'a, 'b> Sub<&'a Wrapping<i128>> for &'b Wrapping<i128> type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output;` | [src]

- `impl Sub<i64> for i64 type Output = i64;` | [src]

- `impl<'a> Sub<u32> for &'a u32 type Output = <u32 as Sub<u32>>::Output;` | [src]

- `impl<'a> Sub<f64> for &'a f64 type Output = <f64 as Sub<f64>>::Output;` | [src]

- `impl<'a> Sub<&'a u32> for u32 type Output = <u32 as Sub<u32>>::Output;` | [src]

- `impl<'a> Sub<&'a f64> for f64 type Output = <f64 as Sub<f64>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a i8> for &'b i8 type Output = <i8 as Sub<i8>>::Output;` | [src]

- `impl<'a> Sub<Wrapping<isize>> for &'a Wrapping<isize> type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output;` | [src]

- `impl<'a> Sub<&'a f32> for f32 type Output = <f32 as Sub<f32>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a i32> for &'b i32 type Output = <i32 as Sub<i32>>::Output;` | [src]

- `impl<'a> Sub<i128> for &'a i128 type Output = <i128 as Sub<i128>>::Output;` | [src]

- `impl Sub<Wrapping<i128>> for Wrapping<i128> type Output = Wrapping<i128>;` | [src]

- `impl<'a> Sub<i64> for &'a i64 type Output = <i64 as Sub<i64>>::Output;` | [src]

- `impl<'a, 'b> Sub<&'a i64> for &'b i64 type Output = <i64 as Sub<i64>>::Output;` | [src]

- `impl Sub<Wrapping<i64>> for Wrapping<i64> type Output = Wrapping<i64>;` | [src]

- `impl Sub<u16> for u16 type Output = u16;` | [src]

- `impl Sub<usize> for usize type Output = usize;` | [src]

- `impl<'a> Sub<Wrapping<u128>> for &'a Wrapping<u128> type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output;` | [src]

- `impl<'a> Sub<&'a Wrapping<u64>> for Wrapping<u64> type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output;` | [src]

- `impl<'a, 'b, T> Sub<&'b BTreeSet<T>> for &'a BTreeSet<T> where T: Ord + Clone, type Output = BTreeSet<T>;` | [src]

- `impl<'a, 'b, T, S> Sub<&'b HashSet<T, S>> for &'a HashSet<T, S> where T: Eq + Hash + Clone, S: BuildHasher + Default, type Output = HashSet<T, S>;` | [src]

- `impl Sub<Duration> for Instant type Output = Instant;` | [src]

- `impl Sub<Instant> for Instant type Output = Duration;` | [src]

- `impl Sub<Duration> for SystemTime type Output = SystemTime;` | [src]

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