Struct redis_module::key::RedisKey

pub struct RedisKey { /* fields omitted */ }

Implementations

impl RedisKey

pub fn open(ctx: *mut RedisModuleCtx, key: &RedisString) -> RedisKey

pub fn get_value<T>(
    &self,
    redis_type: &RedisType
) -> Result<Option<&T>, RedisError>

Panics

Will panic if RedisModule_ModuleTypeGetValue is missing in redismodule.h

pub fn key_type(&self) -> KeyType

Panics

Will panic if RedisModule_KeyType is missing in redismodule.h

pub fn is_null(&self) -> bool

Detects whether the key pointer given to us by Redis is null.

pub fn read(&self) -> Result<Option<String>, RedisError>

pub fn hash_get(&self, field: &str) -> Result<Option<RedisString>, RedisError>

pub fn hash_get_multi<'a, A, B>(
    &self,
    fields: &'a [A]
) -> Result<Option<HMGetResult<'a, A, B>>, RedisError> where
    A: Into<Vec<u8>> + Clone,
    RedisString: Into<B>, 

Returns the values associated with the specified fields in the hash stored at this key. The result will be None if the key does not exist.

Trait Implementations

impl Debug for RedisKey

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

Formats the value using the given formatter.

impl Drop for RedisKey

fn drop(&mut self)

Executes the destructor for this type.