diff --git a/src/lib.rs b/src/lib.rs index 9d32356..2fa19e7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,29 +12,28 @@ //! //! ## What This Is //! -//! This crate is a 100% safe code alternative to both +//! This crate provides 100% safe code alternatives to both //! [arrayvec](https://docs.rs/arrayvec) and //! [smallvec](https://docs.rs/smallvec). //! //! * Being 100% safe means that you have to have some sort of compromise //! compared to the versions using `unsafe`. In this case, the compromise is //! that the element type must implement `Default` to be usable in these vecs. -//! For some people that's an absolute deal-breaker, and if so I understand. +//! This makes TinyVec structures not applicable for truly arbitrary data types. //! However, [quite a //! few](https://doc.rust-lang.org/std/default/trait.Default.html#implementors) -//! types have a `Default` impl, so I think that for a lot of common cases you -//! can use these vecs. -//! * [`ArrayVec`] is an array-backed vec-like where all slots are "live" in the -//! Rust sense, but the structure tracks what the intended length is as you -//! push and pop elements and so forth. If you try to grow the length past the -//! array's capacity it'll error or panic (depending on the method used). +//! types have a `Default` impl, including the common cases such as `u8`, `char` +//! and even `&str`. +//! * [`ArrayVec`] is an array-backed vec-like structure with a fixed capacity. +//! If you try to grow the length past the +//! array's capacity it will error or panic (depending on the method used). //! * (Note: I am _very sorry_ that this type has the same name as the //! `ArrayVec` type in the `arrayvec` crate. We really couldn't think of //! another name for this sort of data structure. Please [contact //! us](https://github.com/Lokathor/tinyvec/issues) with a better name //! before this crate is 1.0 if you can think of one.) //! * [`TinyVec`] is an enum that's either an "inline" `ArrayVec` or a "heap" -//! `Vec`. If it's in array mode and you try to grow the vec beyond it's +//! `Vec`. If it's in array mode and you try to grow the vec beyond its //! capacity it'll quietly transition into heap mode for you and then continue //! operation. This type is naturally behind the `alloc` feature gate. //! @@ -42,29 +41,25 @@ //! //! The crate is still in development, but we have some very clear goals: //! -//! 1) The crate is 100% safe code. By this I don't mean a totally safe API, I -//! mean no `unsafe` internals either. `#![forbid(unsafe_code)]`. -//! * We do use `core` and `alloc` of course, which provide a safe API over -//! `unsafe` operations. However, if you don't at least trust those crates -//! then you've got bigger problems on your hands. +//! 1) The crate is 100% safe code. Not just a safe API - no `unsafe` internals +//! either. `#![forbid(unsafe_code)]`. //! 2) No required dependencies. -//! * We might of course provide optional dependencies for extra +//! * We might provide optional dependencies for extra //! functionality (eg: `serde` compatability), but none of them will be -//! required. I hate dependencies _even more_ than you do. +//! required. //! 3) The _intended_ API is that, as much as possible, these types are //! essentially a "drop-in" replacement for the standard //! [`Vec`](alloc::vec::Vec) type. //! * For `Vec` methods that are not yet Stable, they are sometimes provided -//! via a crate feature, in which case the feature requires Nightly of -//! course. +//! via a crate feature, in which case the feature requires Nightly. //! * If `Vec` methods that are stable but which rely on an unstable library -//! internal, that also requires a feature and a nightly compiler (sorry). +//! internals, that also requires a feature and a nightly compiler (sorry). //! * Some of the methods provided are **not** part of the `Vec` API but are //! none the less important methods to have. In this case, the method names //! are usually fairly long and perhaps even a little silly. It is the hope //! that this "convention" will prevent any potential name clash between //! our vec types and the standard `Vec` type. -//! * That said, I'm not one of those "never 2.0" people, so if `Vec` lands +//! * That said, if `Vec` lands //! some method with the same name as something we have, we'll just bite //! the bullet and fix it with a breaking change.