Enum RespValue 

pub enum RespValue {
    Simple(String),
    Error(String),
    Integer(i64),
    Bulk(Vec<u8>),
    Array(Vec<RespValue>),
    Null,
}

One RESP2 value.

Variants

Simple(String)

A simple string, such as OK.

Error(String)

An error reply. crate::Client::execute returns this as crate::Error::Server.

Integer(i64)

A signed integer.

Bulk(Vec<u8>)

A bulk string, including the empty bulk.

Array(Vec<RespValue>)

An array of values.

Null

A null bulk or a null array.

Implementations

impl RespValue

pub fn as_string(&self) -> Result<Option<String>, Error>

UTF-8 text of a simple string, error, or bulk string. An integer is its decimal form. None when the value is null or an array (including a Pub/Sub push).

Examples found in repository

examples/tour.rs (line 472)

fn transactions(db: &mut Client) -> Result<(), ruvio_client::Error> {
    db.watch_key("{tour}:w")?;
    db.watch(&["{tour}:w"])?;
    db.multi()?;
    db.execute(&["SET", "{tour}:w", "1"])?;
    db.execute(&["INCR", "{tour}:w"])?;
    println!(
        "exec {} replies",
        db.exec()?.map(|replies| replies.len()).unwrap_or(0)
    );
    db.unwatch()?;
    db.multi()?;
    db.discard()?;
    println!(
        "eval {:?}",
        db.eval("return ARGV[1]", &[], &["hi"])?.as_string()?
    );
    let sha = db.script_load("return ruvio.call('GET', KEYS[1])")?;

    println!("script_exists {:?}", db.script_exists(&[&sha, "0000"])?);
    println!(
        "evalsha {:?}",
        db.evalsha(&sha, &["{tour}:w"], &[])?.as_string()?
    );
    db.function_load("tour_echo", "return ARGV[1]")?;
    println!(
        "fcall {:?}",
        db.fcall("tour_echo", &[], &["x"])?.as_string()?
    );
    println!(
        "function_list array {}",
        db.function_list()?.as_array().is_some()
    );
    println!("function_delete {}", db.function_delete("tour_echo")?);
    db.script_flush()?;
    match db.script_kill() {
        Ok(()) => println!("script_kill ok"),
        Err(error) => println!("script_kill {error}"),
    }

    if !db.is_cluster() {
        db.set("{tour}:move", "v")?;
        println!("move {}", db.move_key("{tour}:move", 14)?);
        db.swapdb(14, 15)?;
        println!("swapdb back");
        db.swapdb(14, 15)?;
    }

    Ok(())
}

pub fn as_integer(&self) -> Option<i64>

The integer, or None for any other kind.

pub fn as_array(&self) -> Option<&[RespValue]>

The array items, or None for any other kind.

Examples found in repository

examples/tour.rs (line 421)

fn streams(db: &mut Client) -> Result<(), ruvio_client::Error> {
    let key = "{tour}:stream";
    let first = db.xadd(key, "*", &[("f", "1")])?;

    db.xadd(key, "*", &[("f", "2")])?;
    println!(
        "xadd_maxlen {}",
        db.xadd_maxlen(key, 10, "*", &[("f", "3")])?
    );
    println!(
        "xadd_delay {}",
        db.xadd_delay(key, 60_000, "*", &[("f", "later")])?
    );
    println!("xlen {}", db.xlen(key)?);
    println!("xrange {}", db.xrange(key, "-", "+", None)?[0].id);
    println!(
        "xrevrange {}",
        db.xrevrange(key, "+", "-", Some(1))?[0].fields[0].1
    );
    let read = db.xread(
        &StreamReadOptions {
            count: Some(2),
            ..StreamReadOptions::default()
        },
        &[(key, "0")],
    )?;

    println!("xread {}", read[0].entries.len());
    db.xgroup_create(key, "g", "0", false)?;
    db.xgroup_create("{tour}:fresh", "g", "$", true)?;
    let delivered = db.xreadgroup("g", "c1", &StreamReadOptions::default(), &[(key, ">")])?;

    println!("xreadgroup {}", delivered[0].entries.len());
    let pending = db.xpending(key, "g", "-", "+", 10, &StreamPendingFilter::default())?;

    println!(
        "xpending {} summary-array {}",
        pending.len(),
        db.xpending_summary(key, "g")?.as_array().is_some()
    );
    let claimed = db.xclaim(
        key,
        "g",
        "c2",
        Duration::ZERO,
        &[&first],
        &StreamClaimOptions::default(),
    )?;

    println!("xclaim {}", claimed[0].id);
    println!(
        "xclaim_ids {:?}",
        db.xclaim_ids(
            key,
            "g",
            "c2",
            Duration::ZERO,
            &[&first],
            &StreamClaimOptions::default()
        )?
    );
    println!("xack {}", db.xack(key, "g", &[&first])?);
    println!(
        "xgroup_delconsumer {}",
        db.xgroup_delconsumer(key, "g", "c1")?
    );
    db.xgroup_setid(key, "g", "0")?;
    println!("xgroup_destroy {}", db.xgroup_destroy(key, "g")?);
    println!("xdel {}", db.xdel(key, &[&first])?);
    println!("xtrim {}", db.xtrim_maxlen(key, 1)?);

    Ok(())
}

fn transactions(db: &mut Client) -> Result<(), ruvio_client::Error> {
    db.watch_key("{tour}:w")?;
    db.watch(&["{tour}:w"])?;
    db.multi()?;
    db.execute(&["SET", "{tour}:w", "1"])?;
    db.execute(&["INCR", "{tour}:w"])?;
    println!(
        "exec {} replies",
        db.exec()?.map(|replies| replies.len()).unwrap_or(0)
    );
    db.unwatch()?;
    db.multi()?;
    db.discard()?;
    println!(
        "eval {:?}",
        db.eval("return ARGV[1]", &[], &["hi"])?.as_string()?
    );
    let sha = db.script_load("return ruvio.call('GET', KEYS[1])")?;

    println!("script_exists {:?}", db.script_exists(&[&sha, "0000"])?);
    println!(
        "evalsha {:?}",
        db.evalsha(&sha, &["{tour}:w"], &[])?.as_string()?
    );
    db.function_load("tour_echo", "return ARGV[1]")?;
    println!(
        "fcall {:?}",
        db.fcall("tour_echo", &[], &["x"])?.as_string()?
    );
    println!(
        "function_list array {}",
        db.function_list()?.as_array().is_some()
    );
    println!("function_delete {}", db.function_delete("tour_echo")?);
    db.script_flush()?;
    match db.script_kill() {
        Ok(()) => println!("script_kill ok"),
        Err(error) => println!("script_kill {error}"),
    }

    if !db.is_cluster() {
        db.set("{tour}:move", "v")?;
        println!("move {}", db.move_key("{tour}:move", 14)?);
        db.swapdb(14, 15)?;
        println!("swapdb back");
        db.swapdb(14, 15)?;
    }

    Ok(())
}

fn server(db: &mut Client) -> Result<(), ruvio_client::Error> {
    println!("ping {}", db.ping()?);
    println!("ping_message {}", db.ping_message("tour")?);
    println!("info has ruvio {}", db.info(None)?.contains("ruvio"));
    println!("info server {}", db.info(Some("server"))?.len());
    println!("config_get {}", db.config_get("databases")?.len());
    println!("whoami {}", db.acl_whoami()?);
    println!("acl_users {:?}", db.acl_users()?);
    println!("acl_list {}", db.acl_list()?.len());
    println!("acl_cat {}", db.acl_cat()?.len());
    println!("acl_getuser null {}", db.acl_getuser("default")?.is_null());
    db.acl_setuser("tour-reader", &["on", "~{tour}:*", "+get"])?;
    db.client_setname("ruvio-tour")?;
    println!("client_getname {:?}", db.client_getname()?);
    db.client_tracking(false)?;
    println!("cluster_keyslot {}", db.cluster_keyslot("{tour}")?);

    if db.is_cluster() {
        println!(
            "cluster_nodes {}",
            db.cluster_nodes()?.chars().take(40).collect::<String>()
        );
        println!(
            "cluster_slots array {}",
            db.cluster_slots()?.as_array().is_some()
        );
        println!(
            "cluster_shards array {}",
            db.cluster_shards()?.as_array().is_some()
        );
        println!("cluster_info {}", db.cluster_info()?.len());
        println!("cluster_myid {}", db.cluster_myid()?);
        db.readonly()?;
        db.readwrite()?;
    }

    db.save()?;
    db.bgsave()?;
    println!("hello array {}", db.hello(2)?.as_array().is_some());
    db.execute_many(&[&["PING"], &["PING"]])?;

    Ok(())
}

pub fn is_null(&self) -> bool

True for a null bulk or a null array.

Examples found in repository

examples/tour.rs (line 518)

fn server(db: &mut Client) -> Result<(), ruvio_client::Error> {
    println!("ping {}", db.ping()?);
    println!("ping_message {}", db.ping_message("tour")?);
    println!("info has ruvio {}", db.info(None)?.contains("ruvio"));
    println!("info server {}", db.info(Some("server"))?.len());
    println!("config_get {}", db.config_get("databases")?.len());
    println!("whoami {}", db.acl_whoami()?);
    println!("acl_users {:?}", db.acl_users()?);
    println!("acl_list {}", db.acl_list()?.len());
    println!("acl_cat {}", db.acl_cat()?.len());
    println!("acl_getuser null {}", db.acl_getuser("default")?.is_null());
    db.acl_setuser("tour-reader", &["on", "~{tour}:*", "+get"])?;
    db.client_setname("ruvio-tour")?;
    println!("client_getname {:?}", db.client_getname()?);
    db.client_tracking(false)?;
    println!("cluster_keyslot {}", db.cluster_keyslot("{tour}")?);

    if db.is_cluster() {
        println!(
            "cluster_nodes {}",
            db.cluster_nodes()?.chars().take(40).collect::<String>()
        );
        println!(
            "cluster_slots array {}",
            db.cluster_slots()?.as_array().is_some()
        );
        println!(
            "cluster_shards array {}",
            db.cluster_shards()?.as_array().is_some()
        );
        println!("cluster_info {}", db.cluster_info()?.len());
        println!("cluster_myid {}", db.cluster_myid()?);
        db.readonly()?;
        db.readwrite()?;
    }

    db.save()?;
    db.bgsave()?;
    println!("hello array {}", db.hello(2)?.as_array().is_some());
    db.execute_many(&[&["PING"], &["PING"]])?;

    Ok(())
}

Trait Implementations

impl Clone for RespValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RespValue

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

Formats the value using the given formatter.

impl Eq for RespValue

impl PartialEq for RespValue

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RespValue