Trait sp_std::ops::Rem

1.0.0 · source ·

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

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

Expand description

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: 'a> {
    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§

source

type Output

The resulting type after applying the % operator.

Required Methods§

source

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

Performs the % operation.

Example

assert_eq!(12 % 10, 2);

Implementors§

const: unstable · source§

type Output = <Saturating<usize> as Rem<Saturating<usize>>>::Output

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i8>> for &Wrapping<i8>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i8>> for Wrapping<i8>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i16>> for &Wrapping<i16>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i16>> for Wrapping<i16>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i32>> for &Wrapping<i32>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i32>> for Wrapping<i32>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i64>> for &Wrapping<i64>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i64>> for Wrapping<i64>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i128>> for &Wrapping<i128>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<i128>> for Wrapping<i128>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<isize>> for &Wrapping<isize>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<isize>> for Wrapping<isize>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u8>> for &Wrapping<u8>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u8>> for Wrapping<u8>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u16>> for &Wrapping<u16>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u16>> for Wrapping<u16>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u32>> for &Wrapping<u32>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u32>> for Wrapping<u32>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u64>> for &Wrapping<u64>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u64>> for Wrapping<u64>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u128>> for &Wrapping<u128>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<u128>> for Wrapping<u128>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<usize>> for &Wrapping<usize>

§

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

1.14.0 (const: unstable) · source§

impl Rem<&Wrapping<usize>> for Wrapping<usize>

§

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

const: unstable · source§

impl Rem<f32> 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

const: unstable · source§

impl Rem<f64> 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);

§