Home / Docs / Standard library / Built-in methods

bit_xor

Release v0.4.0Edition 0.2 and later

A built-in method, resolved by the type of its receiver (spec/14 §2). Edition 0.2 and later.

una
a.bit_xor(mask: F) -> F
  where a: F, one of I8, I16, I32, I64, U8, U16, U32, U64

Total; its result is only known to be in the type's range (spec/18 §5).

Receiver

Parameters

Returns

F: the bits set in exactly one of a and mask, on the two's-complement bits of the width; it never fails.

See also

bit_and, bit_or, bit_not

Example

src/shop.unauna
module shop

--- An item's flags with every one of the eight flipped.
pub main() -> Unit
  uses @console: Console[print]
=
  let flags: U8 = 250
  let flipped = flags.bit_xor(mask: 255)
  @console.print("{flipped}")

una run . prints:

Output
5

Specification

Generated from una v0.4.0 (docs/std/builtins.json, which is not part of the specification): built-in methods have no declaration, so una writes these signature lines and tests each against its checker. The specification governs: spec/14 §2.