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

# Trait core::ops::BitOr 1.0.0 [−] [src]

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

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 {
            Scalar(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));Run

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, 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())
        }
    }

    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`

Performs the `|` operation.

## Implementors

- [src]
  `impl BitOr for Wrapping<usize> type Output = Wrapping<usize>;`
- [src]
  `impl<'a> BitOr<Wrapping<usize>> for &'a Wrapping<usize> type Output = <Wrapping<usize> as BitOr<Wrapping<usize>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<usize>> for Wrapping<usize> type Output = <Wrapping<usize> as BitOr<Wrapping<usize>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<usize>> for &'b Wrapping<usize> type Output = <Wrapping<usize> as BitOr<Wrapping<usize>>>::Output;`
- [src]
  `impl BitOr for Wrapping<u8> type Output = Wrapping<u8>;`
- [src]
  `impl<'a> BitOr<Wrapping<u8>> for &'a Wrapping<u8> type Output = <Wrapping<u8> as BitOr<Wrapping<u8>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<u8>> for Wrapping<u8> type Output = <Wrapping<u8> as BitOr<Wrapping<u8>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<u8>> for &'b Wrapping<u8> type Output = <Wrapping<u8> as BitOr<Wrapping<u8>>>::Output;`
- [src]
  `impl BitOr for Wrapping<u16> type Output = Wrapping<u16>;`
- [src]
  `impl<'a> BitOr<Wrapping<u16>> for &'a Wrapping<u16> type Output = <Wrapping<u16> as BitOr<Wrapping<u16>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<u16>> for Wrapping<u16> type Output = <Wrapping<u16> as BitOr<Wrapping<u16>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<u16>> for &'b Wrapping<u16> type Output = <Wrapping<u16> as BitOr<Wrapping<u16>>>::Output;`
- [src]
  `impl BitOr for Wrapping<u32> type Output = Wrapping<u32>;`
- [src]
  `impl<'a> BitOr<Wrapping<u32>> for &'a Wrapping<u32> type Output = <Wrapping<u32> as BitOr<Wrapping<u32>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<u32>> for Wrapping<u32> type Output = <Wrapping<u32> as BitOr<Wrapping<u32>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<u32>> for &'b Wrapping<u32> type Output = <Wrapping<u32> as BitOr<Wrapping<u32>>>::Output;`
- [src]
  `impl BitOr for Wrapping<u64> type Output = Wrapping<u64>;`
- [src]
  `impl<'a> BitOr<Wrapping<u64>> for &'a Wrapping<u64> type Output = <Wrapping<u64> as BitOr<Wrapping<u64>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<u64>> for Wrapping<u64> type Output = <Wrapping<u64> as BitOr<Wrapping<u64>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<u64>> for &'b Wrapping<u64> type Output = <Wrapping<u64> as BitOr<Wrapping<u64>>>::Output;`
- [src]
  `impl BitOr for Wrapping<u128> type Output = Wrapping<u128>;`
- [src]
  `impl<'a> BitOr<Wrapping<u128>> for &'a Wrapping<u128> type Output = <Wrapping<u128> as BitOr<Wrapping<u128>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<u128>> for Wrapping<u128> type Output = <Wrapping<u128> as BitOr<Wrapping<u128>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<u128>> for &'b Wrapping<u128> type Output = <Wrapping<u128> as BitOr<Wrapping<u128>>>::Output;`
- [src]
  `impl BitOr for Wrapping<isize> type Output = Wrapping<isize>;`
- [src]
  `impl<'a> BitOr<Wrapping<isize>> for &'a Wrapping<isize> type Output = <Wrapping<isize> as BitOr<Wrapping<isize>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<isize>> for Wrapping<isize> type Output = <Wrapping<isize> as BitOr<Wrapping<isize>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<isize>> for &'b Wrapping<isize> type Output = <Wrapping<isize> as BitOr<Wrapping<isize>>>::Output;`
- [src]
  `impl BitOr for Wrapping<i8> type Output = Wrapping<i8>;`
- [src]
  `impl<'a> BitOr<Wrapping<i8>> for &'a Wrapping<i8> type Output = <Wrapping<i8> as BitOr<Wrapping<i8>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<i8>> for Wrapping<i8> type Output = <Wrapping<i8> as BitOr<Wrapping<i8>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<i8>> for &'b Wrapping<i8> type Output = <Wrapping<i8> as BitOr<Wrapping<i8>>>::Output;`
- [src]
  `impl BitOr for Wrapping<i16> type Output = Wrapping<i16>;`
- [src]
  `impl<'a> BitOr<Wrapping<i16>> for &'a Wrapping<i16> type Output = <Wrapping<i16> as BitOr<Wrapping<i16>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<i16>> for Wrapping<i16> type Output = <Wrapping<i16> as BitOr<Wrapping<i16>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<i16>> for &'b Wrapping<i16> type Output = <Wrapping<i16> as BitOr<Wrapping<i16>>>::Output;`
- [src]
  `impl BitOr for Wrapping<i32> type Output = Wrapping<i32>;`
- [src]
  `impl<'a> BitOr<Wrapping<i32>> for &'a Wrapping<i32> type Output = <Wrapping<i32> as BitOr<Wrapping<i32>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<i32>> for Wrapping<i32> type Output = <Wrapping<i32> as BitOr<Wrapping<i32>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<i32>> for &'b Wrapping<i32> type Output = <Wrapping<i32> as BitOr<Wrapping<i32>>>::Output;`
- [src]
  `impl BitOr for Wrapping<i64> type Output = Wrapping<i64>;`
- [src]
  `impl<'a> BitOr<Wrapping<i64>> for &'a Wrapping<i64> type Output = <Wrapping<i64> as BitOr<Wrapping<i64>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<i64>> for Wrapping<i64> type Output = <Wrapping<i64> as BitOr<Wrapping<i64>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<i64>> for &'b Wrapping<i64> type Output = <Wrapping<i64> as BitOr<Wrapping<i64>>>::Output;`
- [src]
  `impl BitOr for Wrapping<i128> type Output = Wrapping<i128>;`
- [src]
  `impl<'a> BitOr<Wrapping<i128>> for &'a Wrapping<i128> type Output = <Wrapping<i128> as BitOr<Wrapping<i128>>>::Output;`
- [src]
  `impl<'a> BitOr<&'a Wrapping<i128>> for Wrapping<i128> type Output = <Wrapping<i128> as BitOr<Wrapping<i128>>>::Output;`
- [src]
  `impl<'a, 'b> BitOr<&'a Wrapping<i128>> for &'b Wrapping<i128> type Output = <Wrapping<i128> as BitOr<Wrapping<i128>>>::Output;`
- `impl BitOr for bool type Output = bool;`
- `impl<'a> BitOr<bool> for &'a bool type Output = <bool as BitOr<bool>>::Output;`
- `impl<'a> BitOr<&'a bool> for bool type Output = <bool as BitOr<bool>>::Output;`
- `impl<'a, 'b> BitOr<&'a bool> for &'b bool type Output = <bool as BitOr<bool>>::Output;`
- `impl BitOr for usize type Output = usize;`
- `impl<'a> BitOr<usize> for &'a usize type Output = <usize as BitOr<usize>>::Output;`
- `impl<'a> BitOr<&'a usize> for usize type Output = <usize as BitOr<usize>>::Output;`
- `impl<'a, 'b> BitOr<&'a usize> for &'b usize type Output = <usize as BitOr<usize>>::Output;`
- `impl BitOr for u8 type Output = u8;`
- `impl<'a> BitOr<u8> for &'a u8 type Output = <u8 as BitOr<u8>>::Output;`
- `impl<'a> BitOr<&'a u8> for u8 type Output = <u8 as BitOr<u8>>::Output;`
- `impl<'a, 'b> BitOr<&'a u8> for &'b u8 type Output = <u8 as BitOr<u8>>::Output;`
- `impl BitOr for u16 type Output = u16;`
- `impl<'a> BitOr<u16> for &'a u16 type Output = <u16 as BitOr<u16>>::Output;`
- `impl<'a> BitOr<&'a u16> for u16 type Output = <u16 as BitOr<u16>>::Output;`
- `impl<'a, 'b> BitOr<&'a u16> for &'b u16 type Output = <u16 as BitOr<u16>>::Output;`
- `impl BitOr for u32 type Output = u32;`
- `impl<'a> BitOr<u32> for &'a u32 type Output = <u32 as BitOr<u32>>::Output;`
- `impl<'a> BitOr<&'a u32> for u32 type Output = <u32 as BitOr<u32>>::Output;`
- `impl<'a, 'b> BitOr<&'a u32> for &'b u32 type Output = <u32 as BitOr<u32>>::Output;`
- `impl BitOr for u64 type Output = u64;`
- `impl<'a> BitOr<u64> for &'a u64 type Output = <u64 as BitOr<u64>>::Output;`
- `impl<'a> BitOr<&'a u64> for u64 type Output = <u64 as BitOr<u64>>::Output;`
- `impl<'a, 'b> BitOr<&'a u64> for &'b u64 type Output = <u64 as BitOr<u64>>::Output;`
- `impl BitOr for u128 type Output = u128;`
- `impl<'a> BitOr<u128> for &'a u128 type Output = <u128 as BitOr<u128>>::Output;`
- `impl<'a> BitOr<&'a u128> for u128 type Output = <u128 as BitOr<u128>>::Output;`
- `impl<'a, 'b> BitOr<&'a u128> for &'b u128 type Output = <u128 as BitOr<u128>>::Output;`
- `impl BitOr for isize type Output = isize;`
- `impl<'a> BitOr<isize> for &'a isize type Output = <isize as BitOr<isize>>::Output;`
- `impl<'a> BitOr<&'a isize> for isize type Output = <isize as BitOr<isize>>::Output;`
- `impl<'a, 'b> BitOr<&'a isize> for &'b isize type Output = <isize as BitOr<isize>>::Output;`
- `impl BitOr for i8 type Output = i8;`
- `impl<'a> BitOr<i8> for &'a i8 type Output = <i8 as BitOr<i8>>::Output;`
- `impl<'a> BitOr<&'a i8> for i8 type Output = <i8 as BitOr<i8>>::Output;`
- `impl<'a, 'b> BitOr<&'a i8> for &'b i8 type Output = <i8 as BitOr<i8>>::Output;`
- `impl BitOr for i16 type Output = i16;`
- `impl<'a> BitOr<i16> for &'a i16 type Output = <i16 as BitOr<i16>>::Output;`
- `impl<'a> BitOr<&'a i16> for i16 type Output = <i16 as BitOr<i16>>::Output;`
- `impl<'a, 'b> BitOr<&'a i16> for &'b i16 type Output = <i16 as BitOr<i16>>::Output;`
- `impl BitOr for i32 type Output = i32;`
- `impl<'a> BitOr<i32> for &'a i32 type Output = <i32 as BitOr<i32>>::Output;`
- `impl<'a> BitOr<&'a i32> for i32 type Output = <i32 as BitOr<i32>>::Output;`
- `impl<'a, 'b> BitOr<&'a i32> for &'b i32 type Output = <i32 as BitOr<i32>>::Output;`
- `impl BitOr for i64 type Output = i64;`
- `impl<'a> BitOr<i64> for &'a i64 type Output = <i64 as BitOr<i64>>::Output;`
- `impl<'a> BitOr<&'a i64> for i64 type Output = <i64 as BitOr<i64>>::Output;`
- `impl<'a, 'b> BitOr<&'a i64> for &'b i64 type Output = <i64 as BitOr<i64>>::Output;`
- `impl BitOr for i128 type Output = i128;`
- `impl<'a> BitOr<i128> for &'a i128 type Output = <i128 as BitOr<i128>>::Output;`
- `impl<'a> BitOr<&'a i128> for i128 type Output = <i128 as BitOr<i128>>::Output;`
- `impl<'a, 'b> BitOr<&'a i128> for &'b i128 type Output = <i128 as BitOr<i128>>::Output;`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  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`)