tinyvec_string 0.3.2

//! [`tinyvec`] based string types.
//!
//! `tinyvec_string` provides two string types:
//! * [`ArrayString`], a string backed by a fixed-size array on the stack,
//!   using [`ArrayVec`]
//! * [`TinyString`], a string backed by either a fixed-size array on the stack
//!   or a [`Vec`] on the heap
//!
//! ## Features
//!
//! Like `tinyvec`, `tinyvec_string` is `no_std` by default.
//!
//! `ArrayString` has no dependencies (other than `tinyvec` and `core`).
//!
//! `TinyString` requires the the `alloc` cargo feature to be enabled because
//! it has a dependency on `alloc`:
//!
//! ```toml
//! [dependencies]
//! tinyvec_string = { version = "0.3.2", features = ["alloc"] }
//! ```
//!
//! Error types implement `std::error::Error` when the `std` feature is
//! enabled.
//!
//! The `rustc_1_40` feature enables `tinyvec`'s `rustc_1_40` feature, which enables
//! some optimizations for Rust versions >= 1.40.
//!
//! The `rustc_1_55` feature enables usage of const generics to allow usage of
//! backing arrays of any size.
//!
//! The `rustc_1_57` feature enables `TinyString::try_reserve` and
//! `TinyString::try_reserve_exact`.
//!
//! ## Safety
//!
//! This crate strives to be as safe as possible. Almost all internal `unsafe`
//! code is copied verbatim from `std`'s `String` implementation for maximum
//! reliability and performance.
//!
//! ## MSRV
//!
//! Like `tinyvec`, `tinyvec_string` (without `rustc` version features) supports
//! Rust 1.34+. The `alloc` feature requires Rust 1.36+.
//!
//! [`tinyvec`]: tinyvec/index.html
//! [`ArrayString`]: arraystring/struct.ArrayString.html
//! [`TinyString`]: tinystring/enum.TinyString.html
//! [`ArrayVec`]: tinyvec/struct.ArrayVec.html
//! [`TinyVec`]: tinyvec/enum.TinyVec.html
//! [`Array`]: tinyvec/trait.Array.html
//! [`Vec`]: https://doc.rust-lang.org/std/vec/struct.Vec.html
//! [`std::error::Error`]: https://doc.rust-lang.org/std/error/trait.Error.html

#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docs_rs, feature(doc_cfg))]
// clippy recommends against tabs because of the style guide, which recommends
// spaces in general, but spaces aren't used for source either.
// `std::string::String` implements `PartialEq::ne` explicitly, so
// `tinyvec_string` does as well.
// `copied`/`cloned` can't be used to support Rust 1.34.
#![allow(
	clippy::tabs_in_doc_comments,
	clippy::partialeq_ne_impl,
	clippy::map_clone
)]

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

pub mod arraystring;

pub use arraystring::ArrayString;

#[cfg_attr(docs_rs, doc(cfg(target_feature = "alloc")))]
#[cfg(feature = "alloc")]
pub mod tinystring;

#[cfg_attr(docs_rs, doc(cfg(target_feature = "alloc")))]
#[cfg(feature = "alloc")]
pub use tinystring::TinyString;

pub mod tinyvec;

pub mod bytearray;