Skip to main content

BitmapManager

Struct BitmapManager 

Source
pub struct BitmapManager { /* private fields */ }

Implementations§

Source§

impl BitmapManager

Source

pub async fn setbit(&self, key: &str, offset: usize, value: u8) -> Result<u8>

Set bit at offset to value (SETBIT)

§Arguments
  • key - Bitmap key
  • offset - Bit offset (0-based)
  • value - Bit value (0 or 1)
§Returns

Previous bit value (0 or 1)

Source

pub async fn getbit(&self, key: &str, offset: usize) -> Result<u8>

Get bit at offset (GETBIT)

§Arguments
  • key - Bitmap key
  • offset - Bit offset (0-based)
§Returns

Bit value (0 or 1)

Source

pub async fn bitcount( &self, key: &str, start: Option<usize>, end: Option<usize>, ) -> Result<usize>

Count set bits in bitmap (BITCOUNT)

§Arguments
  • key - Bitmap key
  • start - Optional start offset (inclusive)
  • end - Optional end offset (inclusive)
§Returns

Number of set bits

Source

pub async fn bitpos( &self, key: &str, value: u8, start: Option<usize>, end: Option<usize>, ) -> Result<Option<usize>>

Find first bit set to value (BITPOS)

§Arguments
  • key - Bitmap key
  • value - Bit value to search for (0 or 1)
  • start - Optional start offset (inclusive)
  • end - Optional end offset (inclusive)
§Returns

Position of first matching bit, or None if not found

Source

pub async fn bitop<S>( &self, operation: BitmapOperation, destination: &str, source_keys: &[S], ) -> Result<usize>
where S: AsRef<str>,

Perform bitwise operation on multiple bitmaps (BITOP)

§Arguments
  • operation - Bitwise operation (AND, OR, XOR, NOT)
  • destination - Destination key for result
  • source_keys - Source bitmap keys (NOT requires exactly 1 source)
§Returns

Length of resulting bitmap in bits

§Errors

Returns an error if:

  • NOT operation is used with more than one source key
  • No source keys provided
Source

pub async fn bitfield( &self, key: &str, operations: &[Value], ) -> Result<Vec<i64>>

Execute bitfield operations (BITFIELD)

§Arguments
  • key - Bitmap key
  • operations - Vector of bitfield operations
§Returns

Vector of result values (one per operation)

§Example
use synap_sdk::bitmap::BitmapManager;
use serde_json::json;

let operations = vec![
    json!({
        "operation": "SET",
        "offset": 0,
        "width": 8,
        "signed": false,
        "value": 42
    }),
    json!({
        "operation": "GET",
        "offset": 0,
        "width": 8,
        "signed": false
    }),
    json!({
        "operation": "INCRBY",
        "offset": 0,
        "width": 8,
        "signed": false,
        "increment": 10,
        "overflow": "WRAP"
    }),
];

let results = bitmap.bitfield("mybitmap", &operations).await?;
Source

pub async fn stats(&self) -> Result<BitmapStats>

Retrieve bitmap statistics

Trait Implementations§

Source§

impl Clone for BitmapManager

Source§

fn clone(&self) -> BitmapManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more