W3cubDocs

/Rust

Trait std::ops::Sub

#[lang = "sub"]pub trait Sub<Rhs = Self> {
    type Output;
    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

Subtractable points

use std::ops::Sub;

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

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 = Self;

    fn sub(self, other: Self) -> Self::Output {
        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 });

Associated Types

type Output

The resulting type after applying the - operator.

Loading content...

Required methods

fn sub(self, rhs: Rhs) -> Self::Output

Performs the - operation.

Loading content...

Implementors

impl Sub<f32> for f32[src]

type Output = f32

impl Sub<f64> for f64[src]

type Output = f64

impl Sub<i8> for i8[src]

type Output = i8

impl Sub<i16> for i16[src]

type Output = i16

impl Sub<i32> for i32[src]

type Output = i32

impl Sub<i64> for i64[src]

type Output = i64

impl Sub<i128> for i128[src]

type Output = i128

impl Sub<isize> for isize[src]

type Output = isize

impl Sub<u8> for u8[src]

type Output = u8

impl Sub<u16> for u16[src]

type Output = u16

impl Sub<u32> for u32[src]

type Output = u32

impl Sub<u64> for u64[src]

type Output = u64

impl Sub<u128> for u128[src]

type Output = u128

impl Sub<usize> for usize[src]

type Output = usize

impl Sub<Wrapping<i8>> for Wrapping<i8>[src]

type Output = Wrapping<i8>

impl Sub<Wrapping<i16>> for Wrapping<i16>[src]

type Output = Wrapping<i16>

impl Sub<Wrapping<i32>> for Wrapping<i32>[src]

type Output = Wrapping<i32>

impl Sub<Wrapping<i64>> for Wrapping<i64>[src]

type Output = Wrapping<i64>

impl Sub<Wrapping<i128>> for Wrapping<i128>[src]

type Output = Wrapping<i128>

impl Sub<Wrapping<isize>> for Wrapping<isize>[src]

type Output = Wrapping<isize>

impl Sub<Wrapping<u8>> for Wrapping<u8>[src]

type Output = Wrapping<u8>

impl Sub<Wrapping<u16>> for Wrapping<u16>[src]

type Output = Wrapping<u16>

impl Sub<Wrapping<u32>> for Wrapping<u32>[src]

type Output = Wrapping<u32>

impl Sub<Wrapping<u64>> for Wrapping<u64>[src]

type Output = Wrapping<u64>

impl Sub<Wrapping<u128>> for Wrapping<u128>[src]

type Output = Wrapping<u128>

impl Sub<Wrapping<usize>> for Wrapping<usize>[src]

type Output = Wrapping<usize>

impl Sub<Duration> for Duration[src]

type Output = Duration

impl Sub<Duration> for Instant[src]

type Output = Instant

impl Sub<Duration> for SystemTime[src]

type Output = SystemTime

impl Sub<Instant> for Instant[src]

type Output = Duration

impl<'_> Sub<&'_ f32> for f32[src]

type Output = <f32 as Sub<f32>>::Output

impl<'_> Sub<&'_ f64> for f64[src]

type Output = <f64 as Sub<f64>>::Output

impl<'_> Sub<&'_ i8> for i8[src]

type Output = <i8 as Sub<i8>>::Output

impl<'_> Sub<&'_ i16> for i16[src]

type Output = <i16 as Sub<i16>>::Output

impl<'_> Sub<&'_ i32> for i32[src]

type Output = <i32 as Sub<i32>>::Output

impl<'_> Sub<&'_ i64> for i64[src]

type Output = <i64 as Sub<i64>>::Output

impl<'_> Sub<&'_ i128> for i128[src]

type Output = <i128 as Sub<i128>>::Output

impl<'_> Sub<&'_ isize> for isize[src]

type Output = <isize as Sub<isize>>::Output

impl<'_> Sub<&'_ u8> for u8[src]

type Output = <u8 as Sub<u8>>::Output

impl<'_> Sub<&'_ u16> for u16[src]

type Output = <u16 as Sub<u16>>::Output

impl<'_> Sub<&'_ u32> for u32[src]

type Output = <u32 as Sub<u32>>::Output

impl<'_> Sub<&'_ u64> for u64[src]

type Output = <u64 as Sub<u64>>::Output

impl<'_> Sub<&'_ u128> for u128[src]

type Output = <u128 as Sub<u128>>::Output

impl<'_> Sub<&'_ usize> for usize[src]

type Output = <usize as Sub<usize>>::Output

impl<'_> Sub<&'_ Wrapping<i8>> for Wrapping<i8>[src]

type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output

impl<'_> Sub<&'_ Wrapping<i16>> for Wrapping<i16>[src]

type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output

impl<'_> Sub<&'_ Wrapping<i32>> for Wrapping<i32>[src]

type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output

impl<'_> Sub<&'_ Wrapping<i64>> for Wrapping<i64>[src]

type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output

impl<'_> Sub<&'_ Wrapping<i128>> for Wrapping<i128>[src]

type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output

impl<'_> Sub<&'_ Wrapping<isize>> for Wrapping<isize>[src]

type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output

impl<'_> Sub<&'_ Wrapping<u8>> for Wrapping<u8>[src]

type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output

impl<'_> Sub<&'_ Wrapping<u16>> for Wrapping<u16>[src]

type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output

impl<'_> Sub<&'_ Wrapping<u32>> for Wrapping<u32>[src]

type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output

impl<'_> Sub<&'_ Wrapping<u64>> for Wrapping<u64>[src]

type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output

impl<'_> Sub<&'_ Wrapping<u128>> for Wrapping<u128>[src]

type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output

impl<'_> Sub<&'_ Wrapping<usize>> for Wrapping<usize>[src]

type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output

impl<'_, '_> Sub<&'_ f32> for &'_ f32[src]

type Output = <f32 as Sub<f32>>::Output

impl<'_, '_> Sub<&'_ f64> for &'_ f64[src]

type Output = <f64 as Sub<f64>>::Output

impl<'_, '_> Sub<&'_ i8> for &'_ i8[src]

type Output = <i8 as Sub<i8>>::Output

impl<'_, '_> Sub<&'_ i16> for &'_ i16[src]

type Output = <i16 as Sub<i16>>::Output

impl<'_, '_> Sub<&'_ i32> for &'_ i32[src]

type Output = <i32 as Sub<i32>>::Output

impl<'_, '_> Sub<&'_ i64> for &'_ i64[src]

type Output = <i64 as Sub<i64>>::Output

impl<'_, '_> Sub<&'_ i128> for &'_ i128[src]

type Output = <i128 as Sub<i128>>::Output

impl<'_, '_> Sub<&'_ isize> for &'_ isize[src]

type Output = <isize as Sub<isize>>::Output

impl<'_, '_> Sub<&'_ u8> for &'_ u8[src]

type Output = <u8 as Sub<u8>>::Output

impl<'_, '_> Sub<&'_ u16> for &'_ u16[src]

type Output = <u16 as Sub<u16>>::Output

impl<'_, '_> Sub<&'_ u32> for &'_ u32[src]

type Output = <u32 as Sub<u32>>::Output

impl<'_, '_> Sub<&'_ u64> for &'_ u64[src]

type Output = <u64 as Sub<u64>>::Output

impl<'_, '_> Sub<&'_ u128> for &'_ u128[src]

type Output = <u128 as Sub<u128>>::Output

impl<'_, '_> Sub<&'_ usize> for &'_ usize[src]

type Output = <usize as Sub<usize>>::Output

impl<'_, '_> Sub<&'_ Wrapping<i8>> for &'_ Wrapping<i8>[src]

type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<i16>> for &'_ Wrapping<i16>[src]

type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<i32>> for &'_ Wrapping<i32>[src]

type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<i64>> for &'_ Wrapping<i64>[src]

type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<i128>> for &'_ Wrapping<i128>[src]

type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<isize>> for &'_ Wrapping<isize>[src]

type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<u8>> for &'_ Wrapping<u8>[src]

type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<u16>> for &'_ Wrapping<u16>[src]

type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<u32>> for &'_ Wrapping<u32>[src]

type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<u64>> for &'_ Wrapping<u64>[src]

type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<u128>> for &'_ Wrapping<u128>[src]

type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output

impl<'_, '_> Sub<&'_ Wrapping<usize>> for &'_ Wrapping<usize>[src]

type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output

impl<'_, '_, T> Sub<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
    T: Clone + Ord, [src]

type Output = BTreeSet<T>

fn sub(self, rhs: &BTreeSet<T>) -> BTreeSet<T>[src]

Returns the difference of self and rhs as a new BTreeSet<T>.

Examples

use std::collections::BTreeSet;

let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
let b: BTreeSet<_> = vec![3, 4, 5].into_iter().collect();

let result = &a - &b;
let result_vec: Vec<_> = result.into_iter().collect();
assert_eq!(result_vec, [1, 2]);

impl<'a> Sub<f32> for &'a f32[src]

type Output = <f32 as Sub<f32>>::Output

impl<'a> Sub<f64> for &'a f64[src]

type Output = <f64 as Sub<f64>>::Output

impl<'a> Sub<i8> for &'a i8[src]

type Output = <i8 as Sub<i8>>::Output

impl<'a> Sub<i16> for &'a i16[src]

type Output = <i16 as Sub<i16>>::Output

impl<'a> Sub<i32> for &'a i32[src]

type Output = <i32 as Sub<i32>>::Output

impl<'a> Sub<i64> for &'a i64[src]

type Output = <i64 as Sub<i64>>::Output

impl<'a> Sub<i128> for &'a i128[src]

type Output = <i128 as Sub<i128>>::Output

impl<'a> Sub<isize> for &'a isize[src]

type Output = <isize as Sub<isize>>::Output

impl<'a> Sub<u8> for &'a u8[src]

type Output = <u8 as Sub<u8>>::Output

impl<'a> Sub<u16> for &'a u16[src]

type Output = <u16 as Sub<u16>>::Output

impl<'a> Sub<u32> for &'a u32[src]

type Output = <u32 as Sub<u32>>::Output

impl<'a> Sub<u64> for &'a u64[src]

type Output = <u64 as Sub<u64>>::Output

impl<'a> Sub<u128> for &'a u128[src]

type Output = <u128 as Sub<u128>>::Output

impl<'a> Sub<usize> for &'a usize[src]

type Output = <usize as Sub<usize>>::Output

impl<'a> Sub<Wrapping<i8>> for &'a Wrapping<i8>[src]

type Output = <Wrapping<i8> as Sub<Wrapping<i8>>>::Output

impl<'a> Sub<Wrapping<i16>> for &'a Wrapping<i16>[src]

type Output = <Wrapping<i16> as Sub<Wrapping<i16>>>::Output

impl<'a> Sub<Wrapping<i32>> for &'a Wrapping<i32>[src]

type Output = <Wrapping<i32> as Sub<Wrapping<i32>>>::Output

impl<'a> Sub<Wrapping<i64>> for &'a Wrapping<i64>[src]

type Output = <Wrapping<i64> as Sub<Wrapping<i64>>>::Output

impl<'a> Sub<Wrapping<i128>> for &'a Wrapping<i128>[src]

type Output = <Wrapping<i128> as Sub<Wrapping<i128>>>::Output

impl<'a> Sub<Wrapping<isize>> for &'a Wrapping<isize>[src]

type Output = <Wrapping<isize> as Sub<Wrapping<isize>>>::Output

impl<'a> Sub<Wrapping<u8>> for &'a Wrapping<u8>[src]

type Output = <Wrapping<u8> as Sub<Wrapping<u8>>>::Output

impl<'a> Sub<Wrapping<u16>> for &'a Wrapping<u16>[src]

type Output = <Wrapping<u16> as Sub<Wrapping<u16>>>::Output

impl<'a> Sub<Wrapping<u32>> for &'a Wrapping<u32>[src]

type Output = <Wrapping<u32> as Sub<Wrapping<u32>>>::Output

impl<'a> Sub<Wrapping<u64>> for &'a Wrapping<u64>[src]

type Output = <Wrapping<u64> as Sub<Wrapping<u64>>>::Output

impl<'a> Sub<Wrapping<u128>> for &'a Wrapping<u128>[src]

type Output = <Wrapping<u128> as Sub<Wrapping<u128>>>::Output

impl<'a> Sub<Wrapping<usize>> for &'a Wrapping<usize>[src]

type Output = <Wrapping<usize> as Sub<Wrapping<usize>>>::Output

impl<T, S, '_, '_> Sub<&'_ HashSet<T, S>> for &'_ HashSet<T, S> where
    T: Eq + Hash + Clone,
    S: BuildHasher + Default, [src]

type Output = HashSet<T, S>

fn sub(self, rhs: &HashSet<T, S>) -> HashSet<T, S>[src]

Returns the difference of self and rhs as a new HashSet<T, S>.

Examples

use std::collections::HashSet;

let a: HashSet<_> = vec![1, 2, 3].into_iter().collect();
let b: HashSet<_> = vec![3, 4, 5].into_iter().collect();

let set = &a - &b;

let mut i = 0;
let expected = [1, 2];
for x in &set {
    assert!(expected.contains(x));
    i += 1;
}
assert_eq!(i, expected.len());
Loading content...

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ops/trait.Sub.html