Trait Rem

Help

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

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

Expand description

core The remainder operator %.

Re-exported from core::ops:: .

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§

1.0.0 · Source

type Output

The resulting type after applying the % operator.

Required Methods§

1.0.0 · Source

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

Performs the % operation.

§Example

assert_eq!(12 % 10, 2);

Implementors§

1.0.0 (const: unstable) · Source§

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);

Source §

type Output = f16

1.0.0 (const: unstable) · Source§

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);

Source §

type Output = f32

1.0.0 (const: unstable) · Source§

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);

Source §

type Output = f64

1.0.0 (const: unstable) · Source§

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);

Available on crate feature _float_f64 only.

impl Rem<u32> for &BigUint

Source §

type Output = BigUint

Source §

impl Rem<u32> for Int<u32>

Available on crate feature _int_u32 only.

Source §

Trait RemCopy item path

§Examples

Required Associated Types§

type Output

Required Methods§

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

§Example

Implementors§

impl Rem for f16

§Examples

type Output = f16

impl Rem for f32

§Examples

type Output = f32

impl Rem for f64

§Examples

type Output = f64

impl Rem for f128

§Examples

type Output = f128

impl Rem for i8

§Panics

type Output = i8

impl Rem for i16

§Panics

type Output = i16

impl Rem for i32

§Panics

type Output = i32

impl Rem for i64

§Panics

type Output = i64

impl Rem for i128

§Panics

type Output = i128

impl Rem for isize

§Panics

type Output = isize

impl Rem for u8

§Panics

type Output = u8

impl Rem for u16

§Panics

type Output = u16

impl Rem for u32

§Panics

type Output = u32

impl Rem for u64

§Panics

type Output = u64

impl Rem for u128

§Panics

type Output = u128

impl Rem for usize

§Panics

type Output = usize

impl Rem for Ticks

type Output = Ticks

impl Rem for i24

type Output = i24

impl Rem for u24

type Output = u24

impl Rem for Float<f64>

type Output = Float<f64>

impl Rem for Int<i64>

type Output = Int<i64>

impl Rem for Int<u32>

type Output = Int<u32>

impl Rem for Vec3A

type Output = Vec3A

impl Rem for Vec4

type Output = Vec4

impl Rem for Vec2

type Output = Vec2

impl Rem for Vec3

type Output = Vec3

impl Rem for DVec2

type Output = DVec2

impl Rem for DVec3

type Output = DVec3

Trait Rem