std::ops::BitOr - Rust
Description: API documentation for the Rust `BitOr` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, BitOr

# Trait std::ops::BitOr 1.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));
    }Run

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

## Associated Types

### `type Output`

The resulting type after applying the `|` operator

## Required Methods

### `fn bitor(self, rhs: RHS) -> Self::Output`

The method for the `|` operator

## Implementors

- `impl<'a, 'b, T> BitOr<&'b BTreeSet<T>> for &'a BTreeSet<T> where T: Ord + Clone`
- `impl<E> BitOr<EnumSet<E>> for EnumSet<E> where E: CLike`
- `impl BitOr<Wrapping<usize>> for std::num::Wrapping<usize>`
- `impl BitOr<Wrapping<u8>> for std::num::Wrapping<u8>`
- `impl BitOr<Wrapping<u16>> for std::num::Wrapping<u16>`
- `impl BitOr<Wrapping<u32>> for std::num::Wrapping<u32>`
- `impl BitOr<Wrapping<u64>> for std::num::Wrapping<u64>`
- `impl BitOr<Wrapping<isize>> for std::num::Wrapping<isize>`
- `impl BitOr<Wrapping<i8>> for std::num::Wrapping<i8>`
- `impl BitOr<Wrapping<i16>> for std::num::Wrapping<i16>`
- `impl BitOr<Wrapping<i32>> for std::num::Wrapping<i32>`
- `impl BitOr<Wrapping<i64>> for std::num::Wrapping<i64>`
- `impl<'a> BitOr<Wrapping<usize>> for &'a Wrapping<usize>`
- `impl<'a> BitOr<&'a Wrapping<usize>> for std::num::Wrapping<usize>`
- `impl<'a, 'b> BitOr<&'a Wrapping<usize>> for &'b Wrapping<usize>`
- `impl<'a> BitOr<Wrapping<u8>> for &'a Wrapping<u8>`
- `impl<'a> BitOr<&'a Wrapping<u8>> for std::num::Wrapping<u8>`
- `impl<'a, 'b> BitOr<&'a Wrapping<u8>> for &'b Wrapping<u8>`
- `impl<'a> BitOr<Wrapping<u16>> for &'a Wrapping<u16>`
- `impl<'a> BitOr<&'a Wrapping<u16>> for std::num::Wrapping<u16>`
- `impl<'a, 'b> BitOr<&'a Wrapping<u16>> for &'b Wrapping<u16>`
- `impl<'a> BitOr<Wrapping<u32>> for &'a Wrapping<u32>`
- `impl<'a> BitOr<&'a Wrapping<u32>> for std::num::Wrapping<u32>`
- `impl<'a, 'b> BitOr<&'a Wrapping<u32>> for &'b Wrapping<u32>`
- `impl<'a> BitOr<Wrapping<u64>> for &'a Wrapping<u64>`
- `impl<'a> BitOr<&'a Wrapping<u64>> for std::num::Wrapping<u64>`
- `impl<'a, 'b> BitOr<&'a Wrapping<u64>> for &'b Wrapping<u64>`
- `impl<'a> BitOr<Wrapping<isize>> for &'a Wrapping<isize>`
- `impl<'a> BitOr<&'a Wrapping<isize>> for std::num::Wrapping<isize>`
- `impl<'a, 'b> BitOr<&'a Wrapping<isize>> for &'b Wrapping<isize>`
- `impl<'a> BitOr<Wrapping<i8>> for &'a Wrapping<i8>`
- `impl<'a> BitOr<&'a Wrapping<i8>> for std::num::Wrapping<i8>`
- `impl<'a, 'b> BitOr<&'a Wrapping<i8>> for &'b Wrapping<i8>`
- `impl<'a> BitOr<Wrapping<i16>> for &'a Wrapping<i16>`
- `impl<'a> BitOr<&'a Wrapping<i16>> for std::num::Wrapping<i16>`
- `impl<'a, 'b> BitOr<&'a Wrapping<i16>> for &'b Wrapping<i16>`
- `impl<'a> BitOr<Wrapping<i32>> for &'a Wrapping<i32>`
- `impl<'a> BitOr<&'a Wrapping<i32>> for std::num::Wrapping<i32>`
- `impl<'a, 'b> BitOr<&'a Wrapping<i32>> for &'b Wrapping<i32>`
- `impl<'a> BitOr<Wrapping<i64>> for &'a Wrapping<i64>`
- `impl<'a> BitOr<&'a Wrapping<i64>> for std::num::Wrapping<i64>`
- `impl<'a, 'b> BitOr<&'a Wrapping<i64>> for &'b Wrapping<i64>`
- `impl BitOr<Wrapping<u128>> for std::num::Wrapping<u128>`
- `impl BitOr<Wrapping<i128>> for std::num::Wrapping<i128>`
- `impl<'a> BitOr<Wrapping<u128>> for &'a Wrapping<u128>`
- `impl<'a> BitOr<&'a Wrapping<u128>> for std::num::Wrapping<u128>`
- `impl<'a, 'b> BitOr<&'a Wrapping<u128>> for &'b Wrapping<u128>`
- `impl<'a> BitOr<Wrapping<i128>> for &'a Wrapping<i128>`
- `impl<'a> BitOr<&'a Wrapping<i128>> for std::num::Wrapping<i128>`
- `impl<'a, 'b> BitOr<&'a Wrapping<i128>> for &'b Wrapping<i128>`
- `impl BitOr<bool> for bool`
- `impl BitOr<usize> for usize`
- `impl BitOr<u8> for u8`
- `impl BitOr<u16> for u16`
- `impl BitOr<u32> for u32`
- `impl BitOr<u64> for u64`
- `impl BitOr<isize> for isize`
- `impl BitOr<i8> for i8`
- `impl BitOr<i16> for i16`
- `impl BitOr<i32> for i32`
- `impl BitOr<i64> for i64`
- `impl<'a> BitOr<bool> for &'a bool`
- `impl<'a> BitOr<&'a bool> for bool`
- `impl<'a, 'b> BitOr<&'a bool> for &'b bool`
- `impl<'a> BitOr<usize> for &'a usize`
- `impl<'a> BitOr<&'a usize> for usize`
- `impl<'a, 'b> BitOr<&'a usize> for &'b usize`
- `impl<'a> BitOr<u8> for &'a u8`
- `impl<'a> BitOr<&'a u8> for u8`
- `impl<'a, 'b> BitOr<&'a u8> for &'b u8`
- `impl<'a> BitOr<u16> for &'a u16`
- `impl<'a> BitOr<&'a u16> for u16`
- `impl<'a, 'b> BitOr<&'a u16> for &'b u16`
- `impl<'a> BitOr<u32> for &'a u32`
- `impl<'a> BitOr<&'a u32> for u32`
- `impl<'a, 'b> BitOr<&'a u32> for &'b u32`
- `impl<'a> BitOr<u64> for &'a u64`
- `impl<'a> BitOr<&'a u64> for u64`
- `impl<'a, 'b> BitOr<&'a u64> for &'b u64`
- `impl<'a> BitOr<isize> for &'a isize`
- `impl<'a> BitOr<&'a isize> for isize`
- `impl<'a, 'b> BitOr<&'a isize> for &'b isize`
- `impl<'a> BitOr<i8> for &'a i8`
- `impl<'a> BitOr<&'a i8> for i8`
- `impl<'a, 'b> BitOr<&'a i8> for &'b i8`
- `impl<'a> BitOr<i16> for &'a i16`
- `impl<'a> BitOr<&'a i16> for i16`
- `impl<'a, 'b> BitOr<&'a i16> for &'b i16`
- `impl<'a> BitOr<i32> for &'a i32`
- `impl<'a> BitOr<&'a i32> for i32`
- `impl<'a, 'b> BitOr<&'a i32> for &'b i32`
- `impl<'a> BitOr<i64> for &'a i64`
- `impl<'a> BitOr<&'a i64> for i64`
- `impl<'a, 'b> BitOr<&'a i64> for &'b i64`
- `impl BitOr<u128> for u128`
- `impl BitOr<i128> for i128`
- `impl<'a> BitOr<u128> for &'a u128`
- `impl<'a> BitOr<&'a u128> for u128`
- `impl<'a, 'b> BitOr<&'a u128> for &'b u128`
- `impl<'a> BitOr<i128> for &'a i128`
- `impl<'a> BitOr<&'a i128> for i128`
- `impl<'a, 'b> BitOr<&'a i128> for &'b i128`
- `impl<'a, 'b, T, S> BitOr<&'b HashSet<T, S>> for &'a HashSet<T, S> where T: Eq + Hash + Clone,
  S: BuildHasher + Default`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)