Skip to main content

BitOp

Enum BitOp 

Source
#[non_exhaustive]
pub enum BitOp { And, Or, Xor, Not, }
Expand description

Operator for the BITOP family.

use kevy_store::BitOp;
// NOT takes exactly one source; the callers enforce that, and this
// is what it computes.
assert_eq!(BitOp::Not.combine(&[vec![0b1010_1010]], 1), vec![0b0101_0101]);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

And

Bitwise AND across source keys.

use kevy_store::BitOp;
assert_eq!(BitOp::And.combine(&[vec![0b1100], vec![0b1010]], 1), vec![0b1000]);
§

Or

Bitwise OR across source keys.

use kevy_store::BitOp;
assert_eq!(BitOp::Or.combine(&[vec![0b1100], vec![0b1010]], 1), vec![0b1110]);
§

Xor

Bitwise XOR across source keys.

use kevy_store::BitOp;
assert_eq!(BitOp::Xor.combine(&[vec![0b1100], vec![0b1010]], 1), vec![0b0110]);
§

Not

Bitwise NOT — exactly one source key.

use kevy_store::BitOp;
assert_eq!(BitOp::Not.combine(&[vec![0x0f]], 1), vec![0xf0]);

Implementations§

Source§

impl BitOp

Source

pub fn combine(self, srcs_bytes: &[Vec<u8>], max_len: usize) -> Vec<u8> ⓘ

Combine the source strings under this operator into the max_len-byte destination value (shorter sources zero-padded).

Two rules are easy to get wrong and both are here. A source shorter than the result reads as zero past its end — so an AND with a short source clears the tail, and an OR leaves it alone. And NOT does not stop at its source: Redis inverts the implicit zeros too, so every byte past the source is 0xff.

use kevy_store::BitOp;

let long = b"\xff\xff".to_vec();
let short = b"\x0f".to_vec();
// AND: the second byte meets an implicit zero.
assert_eq!(BitOp::And.combine(&[long.clone(), short.clone()], 2), vec![0x0f, 0x00]);
// OR: the implicit zero changes nothing.
assert_eq!(BitOp::Or.combine(&[long.clone(), short], 2), vec![0xff, 0xff]);
// NOT over a two-byte result from a one-byte source: the tail is 0xff.
assert_eq!(BitOp::Not.combine(&[vec![0x00]], 2), vec![0xff, 0xff]);

Trait Implementations§

Source§

impl Clone for BitOp

Source§

fn clone(&self) -> BitOp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for BitOp

Source§

impl Debug for BitOp

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Eq for BitOp

Source§

impl Hash for BitOp

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BitOp

Source§

fn eq(&self, other: &BitOp) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BitOp

Auto Trait Implementations§

§

impl Freeze for BitOp

§

impl RefUnwindSafe for BitOp

§

impl Send for BitOp

§

impl Sync for BitOp

§

impl Unpin for BitOp

§

impl UnsafeUnpin for BitOp

§

impl UnwindSafe for BitOp

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.