Struct redis_graph::GraphResult

pub struct GraphResult {
    pub data: HashMap<String, GraphValue>,
}

A graph query can return one or multiple values for every matching entry. A GraphResult contains a map of values for a single match. The map keys are the query RETURN statements, values can be of any GraphValue type in any order. The impl also contains some helper methods for easier extraction of graph values.

use redis_graph::GraphResult;
let res = GraphResult::default();

let name:Option<String> = res.get_scalar("person2.name");
let person = res.get_node("person");
let friend_rel = res.get_relation("friend");

Fields

data: HashMap<String, GraphValue>

A map of raw return keys to GraphValues.

Implementations

impl GraphResult

Represents a group of returned graph values for a single matched result in the query. Contains some helper methods for easier extraction of graph values.

pub fn get_value(&self, key: &str) -> Option<&GraphValue>

Returns a single GraphValue by it's key.

pub fn get_scalar<T: FromRedisValue>(&self, key: &str) -> Option<T>

Tries to extract a graph Scalar value into target type T. Will return None in case the key does not exist, the target value is not a Scalar or the value could not be parsed into T.

pub fn get_node(&self, key: &str) -> Option<&NodeValue>

Tries to extract a graph Node value from Value at key. Will return None in case the key does not exist or the target value is not a
Node.

pub fn get_relation(&self, key: &str) -> Option<&RelationValue>

Tries to extract a graph Relation value from Value at key. Will return None in case the key does not exist or the target value is not a
Relation.

Trait Implementations

impl Clone for GraphResult

fn clone(&self) -> GraphResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GraphResult

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

Formats the value using the given formatter.

impl Default for GraphResult

fn default() -> GraphResult

Returns the "default value" for a type.