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

// License: see LICENSE file at root directory of `master` branch

//! # Some JSON implementation
//!
//! ## Project
//!
//! - Repository: <https://bitbucket.org/haibison/sj>
//! - License: Nice License 1.0.0 _(see LICENSE file at root directory of `master` branch)_
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! - This is an implementation of [JSON](https://www.json.org/).
//! - Parsing from [Read][std::io/Read]: [`parse()`][::parse()].
//! - Generating to JSON string: [`Value`][::Value].
//!
//! ## Notes
//!
//! The crate uses `#![no_std]` by default. Documentation is built with all features, which include `std`. If you see some components from
//! [`std`][crate:std] crate, you have to use that feature.
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//!
//! [crate:std]: https://doc.rust-lang.org/std/
//! [std::io/Read]: https://doc.rust-lang.org/std/io/trait.Read.html
//!
//! [::parse()]: fn.parse.html
//! [::Value]: enum.Value.html

#![warn(missing_docs)]
#![no_std]
#![deny(unsafe_code)]

// ╔═════════════════╗
// ║   IDENTIFIERS   ║
// ╚═════════════════╝

macro_rules! code_name  { () => { "sj" }}
macro_rules! version    { () => { "0.18.5" }}

/// # Crate name
pub const NAME: &str = "SJ";

/// # Crate code name
pub const CODE_NAME: &str = code_name!();

/// # ID of this crate
pub const ID: &str = concat!(
    "d1e51da8-8e4e9fc1-6d3f9d7e-c135be7d-a1cdeb80-6920a8dd-d18e7fc6-3e1d2013-",
    "208af671-7371879e-1b7a8d84-2613ca10-dfeea565-302e82c4-53dd84e8-f31d9ead",
);

/// # Crate version
pub const VERSION: &str = version!();

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2019, 12, 30);

/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::d1e51da8::", version!());

// ╔════════════════════╗
// ║   IMPLEMENTATION   ║
// ╚════════════════════╝

#[macro_use]
extern crate alloc;

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

/// # Wrapper for format!(), which prefixes your message with: ::TAG, module_path!(), line!()
macro_rules! __ { ($($arg: tt)+) => {
    format!("[{tag}][{module_path}-{line}] {format}", tag=crate::TAG, module_path=module_path!(), line=line!(), format=format!($($arg)+))
};}

mod bytes;
mod error;
mod number;
mod parser;
mod value;

pub use self::{
    error::*,
    number::*,
    value::*,
};

#[cfg(feature="std")]
pub use self::{
    parser::*,
};

pub mod version_info;

/// # Result type used in this crate
pub type Result<T> = core::result::Result<T, Error>;

/// # Result for I/O functions
#[cfg(feature="std")]
pub type IoResult<T> = core::result::Result<T, std::io::Error>;

#[test]
fn test_crate_version() {
    assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}