Enum ReturnValue

pub enum ReturnValue {
    Array(Vec<ReturnValue>),
    Object(HashMap<String, ReturnValue>),
    Value(Value),
    Empty,
}

A return value enum that represents different possible outputs from graph operations. Can contain traversal results, counts, boolean flags, or empty values.

Variants

Array(Vec<ReturnValue>)

Object(HashMap<String, ReturnValue>)

Value(Value)

Empty

Implementations

impl ReturnValue

pub fn from_properties(properties: HashMap<String, Value>) -> Self

pub fn from_traversal_value_array_with_mixin( traversal_value: Vec<TraversalVal>, mixin: RefMut<'_, HashMap<u128, ResponseRemapping>>, ) -> Self

pub fn from_traversal_value_with_mixin( traversal_value: TraversalVal, mixin: RefMut<'_, HashMap<u128, ResponseRemapping>>, ) -> Self

pub fn mixin(self, other: ReturnValue) -> Self

pub fn mixin_remapping(self, remappings: HashMap<String, Remapping>) -> Self

Mixin a remapping to a return value.

This function takes a hashmap of Remappings and mixes them into the return value

• If the mapping is an exclude, then the key is removed from the return value
• If the mapping is a remapping from an old value to a new value, then the key is replaced with the new name and the value is the new value
• If the mapping is a new mapping, then the key is added to the return value and the value is the new value
• Otherwise, the key is left unchanged and the value is the original value

Basic usage:

use helix_db::protocol::{ReturnValue, Remapping};
use std::collections::HashMap;

let remappings = HashMap::new();
remappings.insert(
    "old_key".to_string(),
    Remapping::new(
        Some("new_key".to_string()),
        ReturnValue::from("new_value".to_string())
    )
);

let return_value = ReturnValue::from("old_value".to_string());
let return_value = return_value.mixin_remapping(remappings);

assert_eq!(
    return_value.get("new_key".to_string()),
    Some(&ReturnValue::from("new_value".to_string()))
);

pub fn mixin_other<I>( &self, item: I, secondary_properties: ResponseRemapping, ) -> Self

where I: Filterable + Clone,

Trait Implementations

impl Clone for ReturnValue

fn clone(&self) -> ReturnValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReturnValue

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

Formats the value using the given formatter.

impl Default for ReturnValue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReturnValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&[f64]> for ReturnValue

fn from(data: &[f64]) -> Self

Converts to this type from the input type.

impl From<&Value> for ReturnValue

fn from(value: &Value) -> Self

Converts to this type from the input type.

impl From<&str> for ReturnValue

fn from(string: &str) -> Self

Converts to this type from the input type.

impl From<Count> for ReturnValue

fn from(count: Count) -> Self

Converts to this type from the input type.

impl<I> From<I> for ReturnValue

where I: Filterable + Clone,

fn from(item: I) -> Self

Converts to this type from the input type.

impl From<String> for ReturnValue

fn from(string: String) -> Self

Converts to this type from the input type.

impl From<TraversalVal> for ReturnValue

fn from(val: TraversalVal) -> Self

Converts to this type from the input type.

impl From<Value> for ReturnValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<TraversalVal>> for ReturnValue

fn from(array: Vec<TraversalVal>) -> Self

Converts to this type from the input type.

impl From<bool> for ReturnValue

fn from(boolean: bool) -> Self

Converts to this type from the input type.

impl From<f64> for ReturnValue

fn from(float: f64) -> Self

Converts to this type from the input type.

impl From<i32> for ReturnValue

fn from(integer: i32) -> Self

Converts to this type from the input type.

impl From<u128> for ReturnValue

fn from(integer: u128) -> Self

Converts to this type from the input type.

impl PartialEq for ReturnValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReturnValue

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReturnValue