1.0.0[−][src]Trait sp_std::ops::Rem

#[lang = "rem"]pub trait Rem<Rhs = Self> {
    type Output;
#[must_use]    pub 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: '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] });

Associated Types

`type Output`[src]

The resulting type after applying the % operator.

Loading content...

Required methods

`#[must_use]pub fn rem(self, rhs: Rhs) -> Self::Output`[src]

Performs the % operation.

Example

assert_eq!(12 % 10, 2);

Loading content...

Implementations on Foreign Types

`impl<'a> Rem<i128> for &'a i128`[src]

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

`pub fn rem(self, other: i128) -> <i128 as Rem<i128>>::Output`[src]

`impl<'a> Rem<f32> for &'a f32`[src]

`type Output = <f32 as Rem<f32>>::Output`

`pub fn rem(self, other: f32) -> <f32 as Rem<f32>>::Output`[src]

`impl Rem<u8> for u8`[src]

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

`type Output = u8`

`pub fn rem(self, other: u8) -> u8`[src]

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

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

`pub fn rem(self, other: &isize) -> <isize as Rem<isize>>::Output`[src]

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

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

`pub fn rem(self, other: &u16) -> <u16 as Rem<u16>>::Output`[src]

`impl<'a> Rem<i8> for &'a i8`[src]

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

`pub fn rem(self, other: i8) -> <i8 as Rem<i8>>::Output`[src]

`impl Rem<u16> for u16`[src]

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

`type Output = u16`

`pub fn rem(self, other: u16) -> u16`[src]

`impl<'a> Rem<f64> for &'a f64`[src]

`type Output = <f64 as Rem<f64>>::Output`

`pub fn rem(self, other: f64) -> <f64 as Rem<f64>>::Output`[src]

`impl<'_> Rem<&'_ isize> for isize`[src]

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

`pub fn rem(self, other: &isize) -> <isize as Rem<isize>>::Output`[src]

`impl<'_> Rem<&'_ f32> for f32`[src]

`type Output = <f32 as Rem<f32>>::Output`

`pub fn rem(self, other: &f32) -> <f32 as Rem<f32>>::Output`[src]

`impl Rem<usize> for usize`[src]

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

`type Output = usize`

`pub fn rem(self, other: usize) -> usize`[src]

`impl Rem<u32> for u32`[src]

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

`type Output = u32`

`pub fn rem(self, other: u32) -> u32`[src]

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

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

`pub fn rem(self, other: &i16) -> <i16 as Rem<i16>>::Output`[src]

`impl<'_> Rem<&'_ u32> for u32`[src]

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

`pub fn rem(self, other: &u32) -> <u32 as Rem<u32>>::Output`[src]

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

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

`pub fn rem(self, other: &i8) -> <i8 as Rem<i8>>::Output`[src]

`impl<'_> Rem<&'_ i16> for i16`[src]

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

`pub fn rem(self, other: &i16) -> <i16 as Rem<i16>>::Output`[src]

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

`type Output = <f32 as Rem<f32>>::Output`

`pub fn rem(self, other: &f32) -> <f32 as Rem<f32>>::Output`[src]

`impl Rem<NonZeroUsize> for usize`[src]

`type Output = usize`

`pub fn rem(self, other: NonZeroUsize) -> usize`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

`impl<'_> Rem<&'_ u64> for u64`[src]

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

`pub fn rem(self, other: &u64) -> <u64 as Rem<u64>>::Output`[src]

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

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

`pub fn rem(self, other: &usize) -> <usize as Rem<usize>>::Output`[src]

`impl<'_> Rem<&'_ i8> for i8`[src]

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

`pub fn rem(self, other: &i8) -> <i8 as Rem<i8>>::Output`[src]

`impl<'_> Rem<&'_ i32> for i32`[src]

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

`pub fn rem(self, other: &i32) -> <i32 as Rem<i32>>::Output`[src]

`impl<'a> Rem<i32> for &'a i32`[src]

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

`pub fn rem(self, other: i32) -> <i32 as Rem<i32>>::Output`[src]

`impl Rem<NonZeroU16> for u16`[src]

`type Output = u16`

`pub fn rem(self, other: NonZeroU16) -> u16`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

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

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

`pub fn rem(self, other: &u32) -> <u32 as Rem<u32>>::Output`[src]

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

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

`pub fn rem(self, other: &u128) -> <u128 as Rem<u128>>::Output`[src]

`impl<'_> Rem<&'_ u8> for u8`[src]

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

`pub fn rem(self, other: &u8) -> <u8 as Rem<u8>>::Output`[src]

`impl<'_> Rem<&'_ u128> for u128`[src]

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

`pub fn rem(self, other: &u128) -> <u128 as Rem<u128>>::Output`[src]

`impl<'_> Rem<&'_ i128> for i128`[src]

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

`pub fn rem(self, other: &i128) -> <i128 as Rem<i128>>::Output`[src]

`impl Rem<u128> for u128`[src]

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

`type Output = u128`

`pub fn rem(self, other: u128) -> u128`[src]

`impl<'a> Rem<u32> for &'a u32`[src]

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

`pub fn rem(self, other: u32) -> <u32 as Rem<u32>>::Output`[src]

`impl<'a> Rem<usize> for &'a usize`[src]

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

`pub fn rem(self, other: usize) -> <usize as Rem<usize>>::Output`[src]

`impl<'_> Rem<&'_ f64> for f64`[src]

`type Output = <f64 as Rem<f64>>::Output`

`pub fn rem(self, other: &f64) -> <f64 as Rem<f64>>::Output`[src]

`impl<'_> Rem<&'_ i64> for i64`[src]

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

`pub fn rem(self, other: &i64) -> <i64 as Rem<i64>>::Output`[src]

`impl Rem<i32> for i32`[src]

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

`type Output = i32`

`pub fn rem(self, other: i32) -> i32`[src]

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

`type Output = <f64 as Rem<f64>>::Output`

`pub fn rem(self, other: &f64) -> <f64 as Rem<f64>>::Output`[src]

`impl Rem<NonZeroU64> for u64`[src]

`type Output = u64`

`pub fn rem(self, other: NonZeroU64) -> u64`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

`impl<'a> Rem<u16> for &'a u16`[src]

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

`pub fn rem(self, other: u16) -> <u16 as Rem<u16>>::Output`[src]

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

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

`pub fn rem(self, other: &i128) -> <i128 as Rem<i128>>::Output`[src]

`impl Rem<NonZeroU128> for u128`[src]

`type Output = u128`

`pub fn rem(self, other: NonZeroU128) -> u128`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

`impl<'a> Rem<u8> for &'a u8`[src]

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

`pub fn rem(self, other: u8) -> <u8 as Rem<u8>>::Output`[src]

`impl Rem<NonZeroU32> for u32`[src]

`type Output = u32`

`pub fn rem(self, other: NonZeroU32) -> u32`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

`impl Rem<f64> for f64`[src]

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`

`pub fn rem(self, other: f64) -> f64`[src]

`impl Rem<i64> for i64`[src]

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

`type Output = i64`

`pub fn rem(self, other: i64) -> i64`[src]

`impl Rem<NonZeroU8> for u8`[src]

`type Output = u8`

`pub fn rem(self, other: NonZeroU8) -> u8`[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

`impl<'_> Rem<&'_ u16> for u16`[src]

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

`pub fn rem(self, other: &u16) -> <u16 as Rem<u16>>::Output`[src]

`impl Rem<f32> for f32`[src]

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