convex 0.10.4

Client library for Convex (convex.dev)
Documentation
use std::collections::BTreeMap;

pub mod export;
mod json;
mod sorting;
use thiserror::Error;

/// A value that can be passed as an argument or returned from Convex functions.
/// They correspond to the [supported Convex types](https://docs.convex.dev/database/types).
#[derive(Clone, Debug)]
#[allow(missing_docs)]
pub enum Value {
    Null,
    Int64(i64),
    Float64(f64),
    Boolean(bool),
    String(String),
    Bytes(Vec<u8>),
    Array(Vec<Value>),
    Object(BTreeMap<String, Value>),
}

impl<T: Into<Value>> From<Option<T>> for Value {
    fn from(v: Option<T>) -> Value {
        v.map(|v| v.into()).unwrap_or(Value::Null)
    }
}

impl From<i64> for Value {
    fn from(v: i64) -> Value {
        Value::Int64(v)
    }
}

impl From<f64> for Value {
    fn from(v: f64) -> Value {
        Value::Float64(v)
    }
}

impl From<bool> for Value {
    fn from(v: bool) -> Value {
        Value::Boolean(v)
    }
}

impl From<&str> for Value {
    fn from(v: &str) -> Value {
        Value::String(v.into())
    }
}

impl From<String> for Value {
    fn from(v: String) -> Value {
        Value::String(v)
    }
}

impl From<Vec<u8>> for Value {
    fn from(v: Vec<u8>) -> Value {
        Value::Bytes(v)
    }
}

impl From<Vec<Value>> for Value {
    fn from(v: Vec<Value>) -> Value {
        Value::Array(v)
    }
}

#[cfg(any(test, feature = "testing"))]
mod proptest {
    use proptest::prelude::*;

    use super::Value;

    impl Arbitrary for Value {
        type Parameters = ();
        type Strategy = proptest::strategy::BoxedStrategy<Self>;

        fn arbitrary_with((): Self::Parameters) -> Self::Strategy {
            value_strategy(4, 32, 8).boxed()
        }
    }

    fn value_strategy(
        depth: usize,
        node_target: usize,
        branching: usize,
    ) -> impl Strategy<Value = Value> {
        // https://altsysrq.github.io/proptest-book/proptest/tutorial/recursive.html
        let leaf = prop_oneof![
            1 => Just(Value::Null),
            1 => any::<i64>().prop_map(Value::from),
            1 => (prop::num::f64::ANY | prop::num::f64::SIGNALING_NAN).prop_map(Value::from),
            1 => any::<bool>().prop_map(Value::from),
            1 => any::<String>().prop_map(Value::String),
            1 => any::<Vec<u8>>().prop_map(Value::Bytes),
        ];
        leaf.prop_recursive(
            depth as u32,
            node_target as u32,
            branching as u32,
            move |inner| {
                prop_oneof![
                    // Manually create the strategies here rather than using the `Arbitrary`
                    // implementations on `Array`, etc. This lets us explicitly pass `inner`
                    // through rather than starting the `Value` strategy from
                    // scratch at each tree level.
                    prop::collection::vec(inner.clone(), 0..branching).prop_map(Value::Array),
                    prop::collection::btree_map(any::<String>(), inner, 0..branching)
                        .prop_map(Value::Object),
                ]
            },
        )
    }
}

/// An application error that can be returned from Convex functions. To learn
/// more about throwing custom application errors, see [Convex Errors](https://docs.convex.dev/functions/error-handling/application-errors#throwing-application-errors).
#[derive(Error, Clone, PartialEq, Eq)]
#[error("{:}", message)]
pub struct ConvexError {
    /// From any error, redacted from prod deployments.
    pub message: String,
    /// Custom application error data payload that can be passed from your
    /// function to a client.
    pub data: Value,
}

impl std::fmt::Debug for ConvexError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let message = &self.message;
        write!(f, "{message:#?}")
    }
}