Struct HMGetResult

pub struct HMGetResult<'a, A, B>
where
    A: Into<Vec<u8>> + Clone,
    RedisString: Into<B>,
{ /* private fields */ }

Opaque type used to hold multi-get results. Use the provided methods to convert the results into the desired type of Rust collection.

Trait Implementations

impl<'a, A, B> IntoIterator for HMGetResult<'a, A, B>

where A: Into<Vec<u8>> + Clone, RedisString: Into<B>,

fn into_iter(self) -> Self::IntoIter

Provides an iterator over the multi-get results in the form of (field-name, field-value) pairs. The type of field-name elements is the same as that passed to the original multi- get call, while the field-value elements may be of any type for which a RedisString Into conversion is implemented.

Examples

Get a HashMap from the results:

use redis_module::key::HMGetResult;
use redis_module::{Context, RedisError, RedisResult, RedisString, RedisValue};

fn call_hash(ctx: &Context, _: Vec<RedisString>) -> RedisResult {
    let key_name = RedisString::create(None, "config");
    let fields = &["username", "password", "email"];
    let hm: HMGetResult<'_, &str, RedisString> = ctx
        .open_key(&key_name)
        .hash_get_multi(fields)?
        .ok_or(RedisError::Str("ERR key not found"))?;
    let response: Vec<RedisValue> = hm.into_iter().map(|(_, v)| v.into()).collect();
    Ok(RedisValue::Array(response))
}

Get a Vec of only the field values from the results:

use redis_module::{Context, RedisError, RedisResult, RedisString, RedisValue};
use redis_module::key::HMGetResult;

fn call_hash(ctx: &Context, _: Vec<RedisString>) -> RedisResult {
    let key_name = RedisString::create(None, "config");
    let fields = &["username", "password", "email"];
    let hm: HMGetResult<'_, &str, RedisString> = ctx
         .open_key(&key_name)
         .hash_get_multi(fields)?
         .ok_or(RedisError::Str("ERR key not found"))?;
    let response: Vec<RedisValue> = hm.into_iter().map(|(_, v)| RedisValue::BulkRedisString(v)).collect();
    Ok(RedisValue::Array(response))
}

type Item = (A, B)

The type of the elements being iterated over.

type IntoIter = HMGetIter<'a, A, B>

Which kind of iterator are we turning this into?