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

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

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

The subtraction operator `-`.

# Examples

This example creates a `Point` struct that implements the `Sub` trait, and then demonstrates subtracting two `Point`s.

    use std::ops::Sub;

    #[derive(Debug)]
    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,
            }
        }
    }

    impl PartialEq for Point {
        fn eq(&self, other: &Self) -> bool {
            self.x == other.x && self.y == other.y
        }
    }

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

Note that `RHS = 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`.

## Associated Types

### `type Output`

The resulting type after applying the `-` operator

## Required Methods

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

The method for the `-` operator

## Implementors

- `impl Sub for Wrapping<usize>`
- `impl<'a> Sub<Wrapping<usize>> for &'a Wrapping<usize>`
- `impl<'a> Sub<&'a Wrapping<usize>> for Wrapping<usize>`
- `impl<'a, 'b> Sub<&'a Wrapping<usize>> for &'b Wrapping<usize>`
- `impl Sub for Wrapping<u8>`
- `impl<'a> Sub<Wrapping<u8>> for &'a Wrapping<u8>`
- `impl<'a> Sub<&'a Wrapping<u8>> for Wrapping<u8>`
- `impl<'a, 'b> Sub<&'a Wrapping<u8>> for &'b Wrapping<u8>`
- `impl Sub for Wrapping<u16>`
- `impl<'a> Sub<Wrapping<u16>> for &'a Wrapping<u16>`
- `impl<'a> Sub<&'a Wrapping<u16>> for Wrapping<u16>`
- `impl<'a, 'b> Sub<&'a Wrapping<u16>> for &'b Wrapping<u16>`
- `impl Sub for Wrapping<u32>`
- `impl<'a> Sub<Wrapping<u32>> for &'a Wrapping<u32>`
- `impl<'a> Sub<&'a Wrapping<u32>> for Wrapping<u32>`
- `impl<'a, 'b> Sub<&'a Wrapping<u32>> for &'b Wrapping<u32>`
- `impl Sub for Wrapping<u64>`
- `impl<'a> Sub<Wrapping<u64>> for &'a Wrapping<u64>`
- `impl<'a> Sub<&'a Wrapping<u64>> for Wrapping<u64>`
- `impl<'a, 'b> Sub<&'a Wrapping<u64>> for &'b Wrapping<u64>`
- `impl Sub for Wrapping<u128>`
- `impl<'a> Sub<Wrapping<u128>> for &'a Wrapping<u128>`
- `impl<'a> Sub<&'a Wrapping<u128>> for Wrapping<u128>`
- `impl<'a, 'b> Sub<&'a Wrapping<u128>> for &'b Wrapping<u128>`
- `impl Sub for Wrapping<isize>`
- `impl<'a> Sub<Wrapping<isize>> for &'a Wrapping<isize>`
- `impl<'a> Sub<&'a Wrapping<isize>> for Wrapping<isize>`
- `impl<'a, 'b> Sub<&'a Wrapping<isize>> for &'b Wrapping<isize>`
- `impl Sub for Wrapping<i8>`
- `impl<'a> Sub<Wrapping<i8>> for &'a Wrapping<i8>`
- `impl<'a> Sub<&'a Wrapping<i8>> for Wrapping<i8>`
- `impl<'a, 'b> Sub<&'a Wrapping<i8>> for &'b Wrapping<i8>`
- `impl Sub for Wrapping<i16>`
- `impl<'a> Sub<Wrapping<i16>> for &'a Wrapping<i16>`
- `impl<'a> Sub<&'a Wrapping<i16>> for Wrapping<i16>`
- `impl<'a, 'b> Sub<&'a Wrapping<i16>> for &'b Wrapping<i16>`
- `impl Sub for Wrapping<i32>`
- `impl<'a> Sub<Wrapping<i32>> for &'a Wrapping<i32>`
- `impl<'a> Sub<&'a Wrapping<i32>> for Wrapping<i32>`
- `impl<'a, 'b> Sub<&'a Wrapping<i32>> for &'b Wrapping<i32>`
- `impl Sub for Wrapping<i64>`
- `impl<'a> Sub<Wrapping<i64>> for &'a Wrapping<i64>`
- `impl<'a> Sub<&'a Wrapping<i64>> for Wrapping<i64>`
- `impl<'a, 'b> Sub<&'a Wrapping<i64>> for &'b Wrapping<i64>`
- `impl Sub for Wrapping<i128>`
- `impl<'a> Sub<Wrapping<i128>> for &'a Wrapping<i128>`
- `impl<'a> Sub<&'a Wrapping<i128>> for Wrapping<i128>`
- `impl<'a, 'b> Sub<&'a Wrapping<i128>> for &'b Wrapping<i128>`
- `impl Sub for usize`
- `impl<'a> Sub<usize> for &'a usize`
- `impl<'a> Sub<&'a usize> for usize`
- `impl<'a, 'b> Sub<&'a usize> for &'b usize`
- `impl Sub for u8`
- `impl<'a> Sub<u8> for &'a u8`
- `impl<'a> Sub<&'a u8> for u8`
- `impl<'a, 'b> Sub<&'a u8> for &'b u8`
- `impl Sub for u16`
- `impl<'a> Sub<u16> for &'a u16`
- `impl<'a> Sub<&'a u16> for u16`
- `impl<'a, 'b> Sub<&'a u16> for &'b u16`
- `impl Sub for u32`
- `impl<'a> Sub<u32> for &'a u32`
- `impl<'a> Sub<&'a u32> for u32`
- `impl<'a, 'b> Sub<&'a u32> for &'b u32`
- `impl Sub for u64`
- `impl<'a> Sub<u64> for &'a u64`
- `impl<'a> Sub<&'a u64> for u64`
- `impl<'a, 'b> Sub<&'a u64> for &'b u64`
- `impl Sub for u128`
- `impl<'a> Sub<u128> for &'a u128`
- `impl<'a> Sub<&'a u128> for u128`
- `impl<'a, 'b> Sub<&'a u128> for &'b u128`
- `impl Sub for isize`
- `impl<'a> Sub<isize> for &'a isize`
- `impl<'a> Sub<&'a isize> for isize`
- `impl<'a, 'b> Sub<&'a isize> for &'b isize`
- `impl Sub for i8`
- `impl<'a> Sub<i8> for &'a i8`
- `impl<'a> Sub<&'a i8> for i8`
- `impl<'a, 'b> Sub<&'a i8> for &'b i8`
- `impl Sub for i16`
- `impl<'a> Sub<i16> for &'a i16`
- `impl<'a> Sub<&'a i16> for i16`
- `impl<'a, 'b> Sub<&'a i16> for &'b i16`
- `impl Sub for i32`
- `impl<'a> Sub<i32> for &'a i32`
- `impl<'a> Sub<&'a i32> for i32`
- `impl<'a, 'b> Sub<&'a i32> for &'b i32`
- `impl Sub for i64`
- `impl<'a> Sub<i64> for &'a i64`
- `impl<'a> Sub<&'a i64> for i64`
- `impl<'a, 'b> Sub<&'a i64> for &'b i64`
- `impl Sub for i128`
- `impl<'a> Sub<i128> for &'a i128`
- `impl<'a> Sub<&'a i128> for i128`
- `impl<'a, 'b> Sub<&'a i128> for &'b i128`
- `impl Sub for f32`
- `impl<'a> Sub<f32> for &'a f32`
- `impl<'a> Sub<&'a f32> for f32`
- `impl<'a, 'b> Sub<&'a f32> for &'b f32`
- `impl Sub for f64`
- `impl<'a> Sub<f64> for &'a f64`
- `impl<'a> Sub<&'a f64> for f64`
- `impl<'a, 'b> Sub<&'a f64> for &'b f64`

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