falkordb 0.1.2

A FalkorDB Rust client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

/*
 * Copyright FalkorDB Ltd. 2023 - present
 * Licensed under the Server Side Public License v1 (SSPLv1).
 */

use crate::{
    parser::{redis_value_as_double, redis_value_as_vec},
    FalkorDBError, FalkorResult,
};

/// A point in the world.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct Point {
    /// The latitude coordinate
    pub latitude: f64,
    /// The longitude coordinate
    pub longitude: f64,
}

impl Point {
    /// Parses a point from a redis::Value::Bulk,
    /// taking the first element as an f64 latitude, and second element as an f64 longitude
    ///
    /// # Arguments
    /// * `value`: The value to parse
    ///
    /// # Returns
    /// Self, if successful
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(name = "Parse Point", skip_all, level = "trace")
    )]
    pub fn parse(value: redis::Value) -> FalkorResult<Point> {
        let [lat, long]: [redis::Value; 2] = redis_value_as_vec(value).and_then(|val_vec| {
            val_vec.try_into().map_err(|_| {
                FalkorDBError::ParsingArrayToStructElementCount(
                    "Expected exactly 2 element in point - latitude and longitude",
                )
            })
        })?;

        Ok(Point {
            latitude: redis_value_as_double(lat)?,
            longitude: redis_value_as_double(long)?,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_valid_point() {
        let value = redis::Value::Bulk(vec![
            redis::Value::Status("45.0".to_string()),
            redis::Value::Status("90.0".to_string()),
        ]);
        let result = Point::parse(value);
        assert!(result.is_ok());
        let point = result.unwrap();
        assert_eq!(point.latitude, 45.0);
        assert_eq!(point.longitude, 90.0);
    }

    #[test]
    fn test_parse_invalid_point_missing_elements() {
        let value = redis::Value::Bulk(vec![redis::Value::Status("45.0".to_string())]);
        let result = Point::parse(value);
        assert!(result.is_err());
        match result {
            Err(FalkorDBError::ParsingArrayToStructElementCount(msg)) => {
                assert_eq!(
                    msg,
                    "Expected exactly 2 element in point - latitude and longitude".to_string()
                );
            }
            _ => panic!("Expected ParsingArrayToStructElementCount error"),
        }
    }

    #[test]
    fn test_parse_invalid_point_extra_elements() {
        let value = redis::Value::Bulk(vec![
            redis::Value::Status("45.0".to_string()),
            redis::Value::Status("90.0".to_string()),
            redis::Value::Status("30.0".to_string()),
        ]);
        let result = Point::parse(value);
        assert!(result.is_err());
        match result {
            Err(FalkorDBError::ParsingArrayToStructElementCount(msg)) => {
                assert_eq!(
                    msg,
                    "Expected exactly 2 element in point - latitude and longitude".to_string()
                );
            }
            _ => panic!("Expected ParsingArrayToStructElementCount error"),
        }
    }

    #[test]
    fn test_parse_invalid_point_not_an_array() {
        let value = redis::Value::Status("not an array".to_string());
        let result = Point::parse(value);
        assert!(result.is_err());
        // Check for the specific error type if needed
    }
}