Trait BitOr

1.0.0 · Source

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

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

Available on crate feature mtls only.

Expand description

The bitwise OR operator |.

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

§Examples

An implementation of BitOr for a wrapper around bool.

use std::ops::BitOr;

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

impl BitOr for Scalar {
    type Output = Self;

    // rhs is the "right-hand side" of the expression `a | b`
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

assert_eq!(Scalar(true) | Scalar(true), Scalar(true));
assert_eq!(Scalar(true) | Scalar(false), Scalar(true));
assert_eq!(Scalar(false) | Scalar(true), Scalar(true));
assert_eq!(Scalar(false) | Scalar(false), Scalar(false));

An implementation of BitOr for a wrapper around Vec<bool>.

use std::ops::BitOr;

#[derive(Debug, PartialEq)]
struct BooleanVector(Vec<bool>);

impl BitOr for BooleanVector {
    type Output = Self;

    fn bitor(self, Self(rhs): Self) -> Self::Output {
        let Self(lhs) = self;
        assert_eq!(lhs.len(), rhs.len());
        Self(
            lhs.iter()
                .zip(rhs.iter())
                .map(|(x, y)| *x | *y)
                .collect()
        )
    }
}

let bv1 = BooleanVector(vec![true, true, false, false]);
let bv2 = BooleanVector(vec![true, false, true, false]);
let expected = BooleanVector(vec![true, true, true, false]);
assert_eq!(bv1 | bv2, expected);

Required Associated Types§

The resulting type after applying the | operator.

Required Methods§

Performs the | operation.

assert_eq!(true | false, true);
assert_eq!(false | false, false);
assert_eq!(5u8 | 1u8, 5);
assert_eq!(5u8 | 2u8, 7);

Implementors§

Or with 0 ( 0 | 0 = 0)

Or with 0 ( 0 | 1 = 1)

X | UTerm = X

Or with 1 ( 1 | B = 1)

UTerm | X = X

UInt<Ul, B0> | UInt<Ur, B0> = UInt<Ul | Ur, B0>

UInt<Ul, B1> | UInt<Ur, B0> = UInt<Ul | Ur, B1>

UInt<Ul, B0> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

UInt<Ul, B1> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

Trait BitOrCopy item path

§Examples

Required Associated Types§

type Output

Required Methods§

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

§Examples

Implementors§

impl BitOr for bool

type Output = bool

impl BitOr for i8

type Output = i8

impl BitOr for i16

type Output = i16

impl BitOr for i32

type Output = i32

impl BitOr for i64

type Output = i64

impl BitOr for i128

type Output = i128

impl BitOr for isize

type Output = isize

impl BitOr for u8

type Output = u8

impl BitOr for u16

type Output = u16

impl BitOr for u32

type Output = u32

impl BitOr for u64

type Output = u64

impl BitOr for u128

type Output = u128

impl BitOr for usize

type Output = usize

impl BitOr for Kind

type Output = Kind

impl BitOr for Options

type Output = Options

impl BitOr for BigInt

type Output = BigInt

impl BitOr for BigUint

type Output = BigUint

impl BitOr for Ipv4Addr

type Output = Ipv4Addr

impl BitOr for Ipv6Addr

type Output = Ipv6Addr

impl BitOr for Saturating<i8>

type Output = Saturating<i8>

impl BitOr for Saturating<i16>

type Output = Saturating<i16>

impl BitOr for Saturating<i32>

type Output = Saturating<i32>

impl BitOr for Saturating<i64>

type Output = Saturating<i64>

impl BitOr for Saturating<i128>

type Output = Saturating<i128>

impl BitOr for Saturating<isize>

type Output = Saturating<isize>

impl BitOr for Saturating<u8>

type Output = Saturating<u8>

impl BitOr for Saturating<u16>

type Output = Saturating<u16>

impl BitOr for Saturating<u32>

type Output = Saturating<u32>

impl BitOr for Saturating<u64>

type Output = Saturating<u64>

impl BitOr for Saturating<u128>

type Output = Saturating<u128>

impl BitOr for Saturating<usize>

type Output = Saturating<usize>

impl BitOr for Wrapping<i8>

type Output = Wrapping<i8>

impl BitOr for Wrapping<i16>

type Output = Wrapping<i16>

impl BitOr for Wrapping<i32>

type Output = Wrapping<i32>

impl BitOr for Wrapping<i64>

type Output = Wrapping<i64>

impl BitOr for Wrapping<i128>

type Output = Wrapping<i128>

Trait BitOr