Trait silx_types::Shl

1.0.0 · source ·

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

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

Expand description

The left shift operator <<. Note that because this trait is implemented for all integer types with multiple right-hand-side types, Rust’s type checker has special handling for _ << _, setting the result type for integer operations to the type of the left-hand-side operand. This means that though a << b and a.shl(b) are one and the same from an evaluation standpoint, they are different when it comes to type inference.

§Examples

An implementation of Shl that lifts the << operation on integers to a wrapper around usize.

use std::ops::Shl;

#[derive(PartialEq, Debug)]
struct Scalar(usize);

impl Shl<Scalar> for Scalar {
    type Output = Self;

    fn shl(self, Self(rhs): Self) -> Self::Output {
        let Self(lhs) = self;
        Self(lhs << rhs)
    }
}

assert_eq!(Scalar(4) << Scalar(2), Scalar(16));

An implementation of Shl that spins a vector leftward by a given amount.

use std::ops::Shl;

#[derive(PartialEq, Debug)]
struct SpinVector<T: Clone> {
    vec: Vec<T>,
}

impl<T: Clone> Shl<usize> for SpinVector<T> {
    type Output = Self;

    fn shl(self, rhs: usize) -> Self::Output {
        // Rotate the vector by `rhs` places.
        let (a, b) = self.vec.split_at(rhs);
        let mut spun_vector = vec![];
        spun_vector.extend_from_slice(b);
        spun_vector.extend_from_slice(a);
        Self { vec: spun_vector }
    }
}

assert_eq!(SpinVector { vec: vec![0, 1, 2, 3, 4] } << 2,
           SpinVector { vec: vec![2, 3, 4, 0, 1] });

Required Associated Types§

source

type Output

The resulting type after applying the << operator.

Required Methods§

source

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

Performs the << operation.

§Examples

assert_eq!(5u8 << 1, 10);
assert_eq!(1u8 << 1, 2);

Trait silx_types::Shl

§Examples

Required Associated Types§

type Output

Required Methods§

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

§Examples

Implementors§

impl Shl for i8

type Output = i8

impl Shl for i16

type Output = i16

impl Shl for i32

type Output = i32

impl Shl for i64

type Output = i64

impl Shl for i128

type Output = i128

impl Shl for isize

type Output = isize

impl Shl for u8

type Output = u8

impl Shl for u16

type Output = u16

impl Shl for u32

type Output = u32

impl Shl for u64

type Output = u64

impl Shl for u128

type Output = u128

impl Shl for usize

type Output = usize

impl Shl for BigEndian<i16>

type Output = i16

impl Shl for BigEndian<i32>

type Output = i32

impl Shl for BigEndian<i64>

type Output = i64

impl Shl for BigEndian<i128>

type Output = i128

impl Shl for BigEndian<u16>

type Output = u16

impl Shl for BigEndian<u32>

type Output = u32

impl Shl for BigEndian<u64>

type Output = u64

impl Shl for BigEndian<u128>

type Output = u128

impl Shl for LittleEndian<i16>

type Output = i16

impl Shl for LittleEndian<i32>

type Output = i32

impl Shl for LittleEndian<i64>

type Output = i64

impl Shl for LittleEndian<i128>

type Output = i128

impl Shl for LittleEndian<u16>

type Output = u16

impl Shl for LittleEndian<u32>

type Output = u32

impl Shl for LittleEndian<u64>

type Output = u64

impl Shl for LittleEndian<u128>

type Output = u128

impl Shl for NativeEndian<i16>

type Output = i16

impl Shl for NativeEndian<i32>

type Output = i32

impl Shl for NativeEndian<i64>

type Output = i64

impl Shl for NativeEndian<i128>

type Output = i128

impl Shl for NativeEndian<u16>

type Output = u16

impl Shl for NativeEndian<u32>

type Output = u32

impl Shl for NativeEndian<u64>

type Output = u64

impl Shl for NativeEndian<u128>

type Output = u128