flexon 0.4.6

SIMD accelerated JSON parser
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

#![cfg_attr(feature = "nightly", feature(likely_unlikely))]
#![cfg_attr(not(doctest), doc = include_str!("../README.md"))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(unsafe_op_in_unsafe_fn)]
#![deny(clippy::std_instead_of_core)]

#[cfg(feature = "serde")]
pub mod serde;
#[cfg(feature = "span")]
pub mod span;

#[cfg(feature = "comment")]
mod comment;
pub mod config;
mod error;
mod fast_float;
mod misc;
mod parser;
pub mod pointer;
mod simd;
pub mod source;
pub mod value;

use crate::{pointer::JsonPointer, source::Source, value::builder::ValueBuilder};

#[doc(inline)]
pub use {
    error::Error,
    parser::Parser,
    value::{LazyValue, OwnedValue, Value},
};

#[doc(inline)]
#[cfg(feature = "serde")]
pub use serde::{
    de::{
        from_mut_null_padded, from_mut_slice, from_mut_slice_unchecked, from_mut_str,
        from_null_padded, from_reader, from_reader_unchecked, from_slice, from_slice_unchecked,
        from_str, get_from, get_from_unchecked,
    },
    ser::{to_string, to_string_pretty, to_vec, to_vec_pretty, to_writer, to_writer_pretty},
};

#[cfg(feature = "comment")]
pub use comment::Comment;

/// Parses a JSON source into the specified type.
///
/// This is a convenience function that creates a parser with default configuration
/// and immediately parses the input. It is equivalent to `Parser::new(src).parse()`.
///
/// # Example
/// ```
/// use flexon::{Value, parse};
///
/// let json = r#"{"width": 20, "height": 50}"#;
/// let value: Value<'_> = parse(json)?;
/// # Ok::<(), flexon::Error>(())
/// ```
#[inline]
pub fn parse<'a, S: Source + 'a, V: ValueBuilder<'a, S>>(s: S) -> Result<V, V::Error> {
    Parser::new(s).parse()
}

/// Skips to the given path and parses JSON into the specified type.
///
/// This is a convenience function that creates a parser with default configuration
/// and immediately parses the input. It is equivalent to `Parser::new(src).parse_at(path)`.
///
/// # Example
/// ```
/// use flexon::{Value, parse_at};
///
/// let json = r#"{"width": 20, "height": 50}"#;
/// let value: Value<'_> = parse_at(json, ["height"])?;
/// # Ok::<(), flexon::Error>(())
/// ```
#[inline]
pub fn parse_at<'a, S, V, P>(s: S, p: P) -> Result<V, V::Error>
where
    S: Source + 'a,
    V: ValueBuilder<'a, S>,
    P: IntoIterator,
    P::Item: JsonPointer,
{
    Parser::new(s).parse_at(p)
}