From e8e7f6297e87003d261a1f3754de512beba2f938 Mon Sep 17 00:00:00 2001 From: Diggory Blake Date: Sat, 21 Nov 2020 18:05:55 +0000 Subject: [PATCH] Prepare for initial release. --- Cargo.toml | 4 ++-- README.md | 2 -- src/lib.rs | 9 +++++++++ 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 6f840ef..3b23adf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ [package] name = "ijson" -version = "0.0.1" +version = "0.1.0" authors = ["Diggory Blake "] edition = "2018" readme = "README.md" license = "MIT OR Apache-2.0" repository = "https://github.com/Diggsey/ijson" -description = "A more memory efficient replacement for serde_json::Value (work-in-progress)" +description = "A more memory efficient replacement for serde_json::Value" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [features] diff --git a/README.md b/README.md index 8157841..e0680cd 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ [![CI Status](https://github.com/Diggsey/ijson/workflows/CI/badge.svg)](https://github.com/Diggsey/ijson/actions?query=workflow%3ACI) [![Documentation](https://docs.rs/ijson/badge.svg)](https://docs.rs/ijson) -! Warning: This crate is still a work-in-progress ! - This crate offers a replacement for `serde-json`'s `Value` type, which is significantly more memory efficient. diff --git a/src/lib.rs b/src/lib.rs index 74eb59e..3dc68ae 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -8,6 +8,15 @@ //! The primary type exposed by this crate is the [`IValue`] type. It is guaranteed //! to be pointer-sized and has a niche (so `Option` is also guaranteed //! to be pointer-sized). +//! +//! Cargo features: +//! +//! - `ctor` +//! A global string cache is used when interning strings. This cache is normally +//! initialized lazily on first use. Enabling the `ctor` feature will cause it +//! to be eagerly initialized on startup. +//! There is no performance benefit to this, but it can help avoid false positives +//! from tools like `mockalloc` which try to detect memory leaks during tests. #![deny(missing_docs, missing_debug_implementations)] #[macro_use]