json-gettext 4.0.5

A library for getting text from JSON usually for internationalization.
Documentation
extern crate serde;

#[cfg(feature = "rocket")]
extern crate rocket;

use std::convert::TryFrom;
use std::fmt::{self, Display, Formatter};
use std::str::FromStr;

#[cfg(feature = "rocket")]
use std::io::Cursor;

use super::JSONGetTextValueError;

use crate::serde_json::{self, to_value, Map, Value};

use serde::de::{Error as DeError, MapAccess, SeqAccess, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};

#[cfg(feature = "rocket")]
use rocket::form::{self, FromFormField, ValueField};
#[cfg(feature = "rocket")]
use rocket::request::{FromParam, Request};
#[cfg(feature = "rocket")]
use rocket::response::{self, Responder, Response};

/// Represents any valid JSON value. Reference can also be wrapped.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum JSONGetTextValue<'a> {
    Str(&'a str),
    JSONValue(Value),
    JSONValueRef(&'a Value),
}

impl<'a> JSONGetTextValue<'a> {
    #[inline]
    #[allow(clippy::should_implement_trait)]
    pub fn from_str<S: AsRef<str> + ?Sized>(s: &'a S) -> JSONGetTextValue<'a> {
        JSONGetTextValue::Str(s.as_ref())
    }

    #[inline]
    pub fn from_string<S: Into<String>>(s: S) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(Value::String(s.into()))
    }

    #[inline]
    pub fn from_json_str<S: AsRef<str>>(
        s: S,
    ) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        JSONGetTextValue::parse_json(s)
    }

    #[inline]
    pub fn from_bool(b: bool) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(Value::Bool(b))
    }

    #[inline]
    pub fn from_i8(n: i8) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_i16(n: i16) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_i32(n: i32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_i64(n: i64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_i128(n: i128) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        Ok(JSONGetTextValue::JSONValue(
            to_value(n).map_err(|_| JSONGetTextValueError::IntegerOutOfRange)?,
        ))
    }

    #[inline]
    pub fn from_isize(n: isize) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_u8(n: u8) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_u16(n: u16) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_u32(n: u32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_u64(n: u64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_u128(n: u128) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        Ok(JSONGetTextValue::JSONValue(
            to_value(n).map_err(|_| JSONGetTextValueError::IntegerOutOfRange)?,
        ))
    }

    #[inline]
    pub fn from_usize(n: usize) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_f32(n: f32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_f64(n: f64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(to_value(n).unwrap())
    }

    #[inline]
    pub fn from_json_value(v: Value) -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(v)
    }

    #[inline]
    pub fn from_json_value_ref(v: &'a Value) -> JSONGetTextValue<'a> {
        JSONGetTextValue::JSONValueRef(v)
    }

    #[inline]
    pub fn from_serializable<T: Serialize>(
        v: T,
    ) -> Result<JSONGetTextValue<'static>, serde_json::Error> {
        Ok(JSONGetTextValue::JSONValue(to_value(v)?))
    }

    #[inline]
    pub fn null() -> JSONGetTextValue<'static> {
        JSONGetTextValue::JSONValue(Value::Null)
    }
}

impl<'a> JSONGetTextValue<'a> {
    /// Convert to a string for JSON format.
    pub fn to_json_string(&self) -> String {
        match self {
            JSONGetTextValue::Str(s) => {
                let mut string = String::with_capacity(s.len() + 2);
                string.push('"');

                let mut from = 0;

                for (i, c) in s.char_indices() {
                    let esc = c.escape_debug();

                    if esc.len() != 1 {
                        string.push_str(&s[from..i]);

                        for c in esc {
                            string.push(c);
                        }

                        from = i + c.len_utf8();
                    }
                }

                string.push_str(&s[from..]);
                string.push('"');

                string
            }
            JSONGetTextValue::JSONValue(v) => v.to_string(),
            JSONGetTextValue::JSONValueRef(v) => v.to_string(),
        }
    }

    #[deprecated(since = "3.2.0", note = "Please use the `to_json_string` function instead")]
    /// Convert to a string for JSON format.
    #[inline]
    pub fn to_json(&self) -> String {
        self.to_json_string()
    }

    /// Convert to a string slice if it is possible (if it is a string).
    #[inline]
    pub fn as_str(&self) -> Option<&str> {
        match self {
            JSONGetTextValue::Str(s) => Some(s),
            JSONGetTextValue::JSONValue(v) => {
                match v {
                    Value::String(s) => Some(s),
                    _ => None,
                }
            }
            JSONGetTextValue::JSONValueRef(v) => {
                match v {
                    Value::String(s) => Some(s),
                    _ => None,
                }
            }
        }
    }

    /// Clone the reference of this `JSONGetTextValue` instance.
    #[inline]
    pub fn clone_borrowed(&self) -> JSONGetTextValue {
        match self {
            JSONGetTextValue::Str(s) => JSONGetTextValue::Str(s),
            JSONGetTextValue::JSONValue(v) => JSONGetTextValue::JSONValueRef(v),
            JSONGetTextValue::JSONValueRef(v) => JSONGetTextValue::JSONValueRef(v),
        }
    }
}

impl<'a> PartialEq<JSONGetTextValue<'a>> for str {
    #[inline]
    fn eq(&self, other: &JSONGetTextValue) -> bool {
        match other {
            JSONGetTextValue::Str(s) => s.eq(&self),
            JSONGetTextValue::JSONValue(v) => v.eq(&self),
            JSONGetTextValue::JSONValueRef(v) => v.eq(&self),
        }
    }
}

impl<'a> PartialEq<JSONGetTextValue<'a>> for &'a str {
    #[inline]
    fn eq(&self, other: &JSONGetTextValue) -> bool {
        match other {
            JSONGetTextValue::Str(s) => s.eq(self),
            JSONGetTextValue::JSONValue(v) => v.eq(self),
            JSONGetTextValue::JSONValueRef(v) => v.eq(self),
        }
    }
}

impl<'a> PartialEq<str> for JSONGetTextValue<'a> {
    #[inline]
    fn eq(&self, other: &str) -> bool {
        match self {
            JSONGetTextValue::Str(s) => s.eq(&other),
            JSONGetTextValue::JSONValue(v) => v.eq(&other),
            JSONGetTextValue::JSONValueRef(v) => v.eq(&other),
        }
    }
}

impl<'a> Display for JSONGetTextValue<'a> {
    #[inline]
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            JSONGetTextValue::Str(s) => s.fmt(f),
            JSONGetTextValue::JSONValue(v) => {
                match v.as_str() {
                    Some(s) => s.fmt(f),
                    None => v.fmt(f),
                }
            }
            JSONGetTextValue::JSONValueRef(v) => {
                match v.as_str() {
                    Some(s) => s.fmt(f),
                    None => v.fmt(f),
                }
            }
        }
    }
}

impl<'a> From<&'a str> for JSONGetTextValue<'a> {
    #[inline]
    fn from(v: &'a str) -> JSONGetTextValue<'a> {
        JSONGetTextValue::from_str(v)
    }
}

impl From<String> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: String) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_string(v)
    }
}

impl From<bool> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: bool) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_bool(v)
    }
}

impl From<i8> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: i8) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_i8(v)
    }
}

impl From<i16> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: i16) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_i16(v)
    }
}

impl From<i32> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: i32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_i32(v)
    }
}

impl From<i64> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: i64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_i64(v)
    }
}

impl From<isize> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: isize) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_isize(v)
    }
}

impl TryFrom<i128> for JSONGetTextValue<'static> {
    type Error = JSONGetTextValueError;

    #[inline]
    fn try_from(v: i128) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        JSONGetTextValue::from_i128(v)
    }
}

impl From<u8> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: u8) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_u8(v)
    }
}

impl From<u16> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: u16) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_u16(v)
    }
}

impl From<u32> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: u32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_u32(v)
    }
}

impl From<u64> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: u64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_u64(v)
    }
}

impl From<usize> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: usize) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_usize(v)
    }
}

impl TryFrom<u128> for JSONGetTextValue<'static> {
    type Error = JSONGetTextValueError;

    #[inline]
    fn try_from(v: u128) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        JSONGetTextValue::from_u128(v)
    }
}

impl From<f32> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: f32) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_f32(v)
    }
}

impl From<f64> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: f64) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_f64(v)
    }
}

impl From<Value> for JSONGetTextValue<'static> {
    #[inline]
    fn from(v: Value) -> JSONGetTextValue<'static> {
        JSONGetTextValue::from_json_value(v)
    }
}

impl<'a> From<&'a Value> for JSONGetTextValue<'a> {
    #[inline]
    fn from(v: &'a Value) -> JSONGetTextValue<'a> {
        JSONGetTextValue::from_json_value_ref(v)
    }
}

impl FromStr for JSONGetTextValue<'static> {
    type Err = ();

    #[inline]
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(JSONGetTextValue::from_string(s))
    }
}

// TODO serde

impl<'a> JSONGetTextValue<'a> {
    #[inline]
    pub fn parse_json<S: AsRef<str>>(
        s: S,
    ) -> Result<JSONGetTextValue<'static>, JSONGetTextValueError> {
        Ok(JSONGetTextValue::JSONValue(serde_json::from_str(s.as_ref())?))
    }
}

impl<'a> Serialize for JSONGetTextValue<'a> {
    #[inline]
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer, {
        match self {
            JSONGetTextValue::Str(s) => s.serialize(serializer),
            JSONGetTextValue::JSONValue(v) => v.serialize(serializer),
            JSONGetTextValue::JSONValueRef(v) => v.serialize(serializer),
        }
    }
}

struct JSONGetTextValueVisitor;

impl<'de> Visitor<'de> for JSONGetTextValueVisitor {
    type Value = JSONGetTextValue<'de>;

    serde::serde_if_integer128! {
        #[inline]
        fn visit_i128<E>(self, v: i128) -> Result<JSONGetTextValue<'static>, E> where E: DeError {
            JSONGetTextValue::from_i128(v).map_err(DeError::custom)
        }
    }

    serde::serde_if_integer128! {
        #[inline]
        fn visit_u128<E>(self, v: u128) -> Result<JSONGetTextValue<'static>, E> where E: DeError {
            JSONGetTextValue::from_u128(v).map_err(DeError::custom)
        }
    }

    #[inline]
    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("a json value")
    }

    #[inline]
    fn visit_bool<E>(self, v: bool) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_bool(v))
    }

    #[inline]
    fn visit_i64<E>(self, v: i64) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_i64(v))
    }

    #[inline]
    fn visit_u64<E>(self, v: u64) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_u64(v))
    }

    #[inline]
    fn visit_f64<E>(self, v: f64) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_f64(v))
    }

    #[inline]
    fn visit_str<E>(self, v: &str) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_string(v.to_string()))
    }

    #[inline]
    fn visit_borrowed_str<E>(self, v: &'de str) -> Result<JSONGetTextValue<'de>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_str(v))
    }

    #[inline]
    fn visit_string<E>(self, v: String) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::from_string(v))
    }

    #[inline]
    fn visit_none<E>(self) -> Result<JSONGetTextValue<'static>, E>
    where
        E: DeError, {
        Ok(JSONGetTextValue::null())
    }

    #[inline]
    fn visit_seq<A>(self, mut seq: A) -> Result<JSONGetTextValue<'static>, A::Error>
    where
        A: SeqAccess<'de>, {
        let mut v = match seq.size_hint() {
            Some(size) => Vec::with_capacity(size),
            None => Vec::new(),
        };

        while let Some(e) = seq.next_element()? {
            v.push(e);
        }

        Ok(JSONGetTextValue::from_json_value(Value::Array(v)))
    }

    #[inline]
    fn visit_map<A>(self, mut map: A) -> Result<JSONGetTextValue<'static>, A::Error>
    where
        A: MapAccess<'de>, {
        let mut v = match map.size_hint() {
            Some(size) => Map::with_capacity(size),
            None => Map::new(),
        };

        while let Some((k, e)) = map.next_entry()? {
            v.insert(k, e);
        }

        Ok(JSONGetTextValue::from_json_value(Value::Object(v)))
    }
}

impl<'de> Deserialize<'de> for JSONGetTextValue<'de> {
    #[inline]
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>, {
        deserializer.deserialize_str(JSONGetTextValueVisitor)
    }
}

// TODO Rocket

#[cfg(feature = "rocket")]
impl<'r, 'o: 'r> Responder<'r, 'o> for JSONGetTextValue<'o> {
    fn respond_to(self, _: &'r Request<'_>) -> response::Result<'o> {
        let mut response = Response::build();

        let s = self.to_json_string();

        response
            .raw_header("Content-Type", "application/json")
            .raw_header("Content-Length", format!("{}", s.len()))
            .sized_body(s.len(), Cursor::new(s));

        response.ok()
    }
}

#[cfg(feature = "rocket")]
impl<'a> FromParam<'a> for JSONGetTextValue<'a> {
    type Error = JSONGetTextValueError;

    fn from_param(param: &'a str) -> Result<Self, Self::Error> {
        JSONGetTextValue::parse_json(param)
    }
}

#[cfg(feature = "rocket")]
#[rocket::async_trait]
impl<'v> FromFormField<'v> for JSONGetTextValue<'v> {
    fn from_value(field: ValueField<'v>) -> form::Result<'v, Self> {
        Ok(JSONGetTextValue::parse_json(field.value).map_err(form::Error::custom)?)
    }
}