Trait std::ops::BitOr1.0.0 [−] [src]

pub trait BitOr<RHS = Self> {
    type Output;
    fn bitor(self, rhs: RHS) -> Self::Output;
}

The BitOr trait is used to specify the functionality of |.

Examples

In this example, the | operator is lifted to a trivial Scalar type.

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 {
        Scalar(self.0 | rhs.0)
    }
}

fn main() {
    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));
}

In this example, the BitOr trait is implemented for a BooleanVector struct.

use std::ops::BitOr;

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

impl BitOr for BooleanVector {
    type Output = Self;

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

fn main() {
    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);
}

Associated Types

The resulting type after applying the | operator

Required Methods

The method for the | operator

Implementors