conjure-serde 5.11.0

Serde Serializer and Deserializer wrappers for Conjure
Documentation
// Copyright 2018 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::de::null_collections_behavior::NullCollectionsBehavior;
use crate::de::unknown_fields_behavior::UnknownFieldsBehavior;
use crate::json::de::client::ValueBehavior;
use serde::de;
use serde_json::de::{IoRead, Read, SliceRead, StrRead};
use serde_json::Error;
use std::io;

/// Deserializes a value from a reader of JSON data.
pub fn server_from_reader<R, T>(reader: R) -> Result<T, Error>
where
    R: io::Read,
    T: de::DeserializeOwned,
{
    let mut de = ServerDeserializer::from_reader(reader);
    let value = T::deserialize(&mut de)?;
    de.end()?;
    Ok(value)
}

/// Deserializes a value from a string of JSON data.
pub fn server_from_str<'a, T>(s: &'a str) -> Result<T, Error>
where
    T: de::Deserialize<'a>,
{
    let mut de = ServerDeserializer::from_str(s);
    let value = T::deserialize(&mut de)?;
    de.end()?;
    Ok(value)
}

/// Deserializes a value from a slice of JSON data.
pub fn server_from_slice<'a, T>(s: &'a [u8]) -> Result<T, Error>
where
    T: de::Deserialize<'a>,
{
    let mut de = ServerDeserializer::from_slice(s);
    let value = T::deserialize(&mut de)?;
    de.end()?;
    Ok(value)
}

/// A serde JSON deserializer appropriate for use by Conjure servers.
///
/// In contrast to serde_json, the f32 and f64 types can be deserialized from the strings `"Infinity"`, `"-Infinity"`,
/// and `"NaN"`, and bytes are deserialized from base64 encoded strings. Unknown object fields trigger errors.
pub struct ServerDeserializer<R>(serde_json::Deserializer<R>);

impl<R> ServerDeserializer<IoRead<R>>
where
    R: io::Read,
{
    /// Creates a Conjure JSON server deserializer from an `io::Read`.
    pub fn from_reader(reader: R) -> ServerDeserializer<IoRead<R>> {
        ServerDeserializer(serde_json::Deserializer::from_reader(reader))
    }
}

impl<'a> ServerDeserializer<SliceRead<'a>> {
    /// Creates a Conjure JSON server deserializer from a `&[u8]`.
    pub fn from_slice(bytes: &'a [u8]) -> ServerDeserializer<SliceRead<'a>> {
        ServerDeserializer(serde_json::Deserializer::from_slice(bytes))
    }
}

impl<'a> ServerDeserializer<StrRead<'a>> {
    /// Creates a Conjure JSON server deserializer from a `&str`.
    #[allow(clippy::should_implement_trait)] // match serde_json's API
    pub fn from_str(s: &'a str) -> ServerDeserializer<StrRead<'a>> {
        ServerDeserializer(serde_json::Deserializer::from_str(s))
    }
}

impl<'de, R> ServerDeserializer<R>
where
    R: Read<'de>,
{
    /// Validates that the input stream is at the end or that it only has trailing whitespace.
    pub fn end(&mut self) -> Result<(), Error> {
        self.0.end()
    }
}

impl<'a, 'de, R> de::Deserializer<'de> for &'a mut ServerDeserializer<R>
where
    R: Read<'de>,
{
    impl_deserialize_body!(
        &'a mut serde_json::Deserializer<R>,
        UnknownFieldsBehavior<NullCollectionsBehavior<ValueBehavior>>
    );

    // we can't delegate this due to the signature, but luckily we know the answer
    fn is_human_readable(&self) -> bool {
        true
    }
}