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

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

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

The bitwise XOR operator `^`.

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

# Examples

An implementation of `BitXor` that lifts `^` to a wrapper around `bool`.

    use std::ops::BitXor;

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

    impl BitXor for Scalar {
        type Output = Self;

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

    assert_eq!(Scalar(true) ^ Scalar(true), Scalar(false));
    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 `BitXor` trait for a wrapper around `Vec<bool>`.

    use std::ops::BitXor;

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

    impl BitXor for BooleanVector {
        type Output = Self;

        fn bitxor(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) && !(*x && *y))
                             .collect())
        }
    }

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

## Associated Types

### `type Output`

The resulting type after applying the `^` operator.

## Required Methods

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

Performs the `^` operation.

## Implementors

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