Trait Rem 

pub trait Rem<Rhs = Self> {
    type Output;

    // Required method
    fn rem(self, rhs: Rhs) -> Self::Output;
}

The remainder operator %.

Note that Rhs is Self by default, but this is not mandatory.

Examples

This example implements Rem on a SplitSlice object. After Rem is implemented, one can use the % operator to find out what the remaining elements of the slice would be after splitting it into equal slices of a given length.

use std::ops::Rem;

#[derive(PartialEq, Debug)]
struct SplitSlice<'a, T> {
    slice: &'a [T],
}

impl<'a, T> Rem<usize> for SplitSlice<'a, T> {
    type Output = Self;

    fn rem(self, modulus: usize) -> Self::Output {
        let len = self.slice.len();
        let rem = len % modulus;
        let start = len - rem;
        Self {slice: &self.slice[start..]}
    }
}

// If we were to divide &[0, 1, 2, 3, 4, 5, 6, 7] into slices of size 3,
// the remainder would be &[6, 7].
assert_eq!(SplitSlice { slice: &[0, 1, 2, 3, 4, 5, 6, 7] } % 3,
           SplitSlice { slice: &[6, 7] });

Required Associated Types

type Output

The resulting type after applying the % operator.

Required Methods

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

Performs the % operation.

Example

assert_eq!(12 % 10, 2);

Implementors

impl Rem for f16

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f16

impl Rem for f32

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f32

impl Rem for f64

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f64

impl Rem for f128

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f128

impl Rem for i8

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i8

impl Rem for i16

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i16

impl Rem for i32

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i32

impl Rem for i64

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i64

impl Rem for i128

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i128

impl Rem for isize

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = isize

impl Rem for u8

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u8

impl Rem for u16

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u16

impl Rem for u32

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u32

impl Rem for u64

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u64

impl Rem for u128

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u128

impl Rem for usize

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = usize

impl Rem<&f16> for &f16

type Output = <f16 as Rem>::Output

impl Rem<&f16> for f16

type Output = <f16 as Rem>::Output

impl Rem<&f32> for &f32

type Output = <f32 as Rem>::Output

impl Rem<&f32> for f32

type Output = <f32 as Rem>::Output

impl Rem<&f64> for &f64

type Output = <f64 as Rem>::Output

impl Rem<&f64> for f64

type Output = <f64 as Rem>::Output

impl Rem<&f128> for &f128

type Output = <f128 as Rem>::Output

impl Rem<&f128> for f128

type Output = <f128 as Rem>::Output

impl Rem<&i8> for &i8

type Output = <i8 as Rem>::Output

impl Rem<&i8> for i8

type Output = <i8 as Rem>::Output

impl Rem<&i16> for &i16

type Output = <i16 as Rem>::Output

impl Rem<&i16> for i16

type Output = <i16 as Rem>::Output

impl Rem<&i32> for &i32

type Output = <i32 as Rem>::Output

impl Rem<&i32> for i32

type Output = <i32 as Rem>::Output

impl Rem<&i64> for &i64

type Output = <i64 as Rem>::Output

impl Rem<&i64> for i64

type Output = <i64 as Rem>::Output

impl Rem<&i128> for &i128

type Output = <i128 as Rem>::Output

impl Rem<&i128> for i128

type Output = <i128 as Rem>::Output

impl Rem<&isize> for &isize

type Output = <isize as Rem>::Output

impl Rem<&isize> for isize

type Output = <isize as Rem>::Output

impl Rem<&u8> for &u8

type Output = <u8 as Rem>::Output

impl Rem<&u8> for u8

type Output = <u8 as Rem>::Output

impl Rem<&u16> for &u16

type Output = <u16 as Rem>::Output

impl Rem<&u16> for u16

type Output = <u16 as Rem>::Output

impl Rem<&u32> for &u32

type Output = <u32 as Rem>::Output

impl Rem<&u32> for u32

type Output = <u32 as Rem>::Output

impl Rem<&u64> for &u64

type Output = <u64 as Rem>::Output

impl Rem<&u64> for u64

type Output = <u64 as Rem>::Output

impl Rem<&u128> for &u128

type Output = <u128 as Rem>::Output

impl Rem<&u128> for u128

type Output = <u128 as Rem>::Output

impl Rem<&usize> for &usize

type Output = <usize as Rem>::Output

impl Rem<&usize> for usize

type Output = <usize as Rem>::Output

impl Rem<f16> for &f16

type Output = <f16 as Rem>::Output

impl Rem<f32> for &f32

type Output = <f32 as Rem>::Output

impl Rem<f64> for &f64

type Output = <f64 as Rem>::Output

impl Rem<f128> for &f128

type Output = <f128 as Rem>::Output

impl Rem<i8> for &i8

type Output = <i8 as Rem>::Output

impl Rem<i16> for &i16

type Output = <i16 as Rem>::Output

impl Rem<i32> for &i32

type Output = <i32 as Rem>::Output

impl Rem<i64> for &i64

type Output = <i64 as Rem>::Output

impl Rem<i128> for &i128

type Output = <i128 as Rem>::Output

impl Rem<isize> for &isize

type Output = <isize as Rem>::Output

impl Rem<u8> for &u8

type Output = <u8 as Rem>::Output

impl Rem<u16> for &u16

type Output = <u16 as Rem>::Output

impl Rem<u32> for &u32

type Output = <u32 as Rem>::Output

impl Rem<u64> for &u64

type Output = <u64 as Rem>::Output

impl Rem<u128> for &u128

type Output = <u128 as Rem>::Output

impl Rem<usize> for &usize

type Output = <usize as Rem>::Output