`hipstr`

Yet another string for Rust 🦀

no copy literal wrapping via from_static (a constructor!)
no alloc small strings (23 bytes on 64-bit platform)
no copy owned slices
zero dependency

And bytes too!

⚡ Examples

```rust use hipstr::HipStr;

let simplegreetings = HipStr::fromstatic("Hello world"); let clone = simplegreetings.clone(); // no copy

let user = "John"; let greetings = HipStr::from(format!("Hello {}", user)); let _user = greetings.slice(6..): // no copy ```

✏️ Features

serde: serialization/deserialization support with serde crate
unstable: exposes internal Backend trait that may change at any moment

☣️ Safety of `hipstr`

This crate uses unsafe extensively. 🤷

It exploits a 1-bit alignment niche in pointer existing on most platform (I think all Rustc supported platform) to distinguish the inline representation from the other representations.

To make things safer, Rust is tested thoroughly on multiple platforms, normally and with Miri (MIR interpreter).

🧪 Testing

☔ Coverage

This crate has near full line coverage:

```bash cargo llvm-cov --all-features --html

or

cargo tarpaulin --all-features --out html --engine llvm ```

🖥️ Cross-platform testing

With cross:

bash cross test --target mips-unknown-linux-gnu # 32-bit BE cross test --target mips64-unknown-linux-gnuabi64 # 64-bit BE cross test --target i686-unknown-linux-gnu # 32-bit LE cross test --target x86_64-unknown-linux-gnu # 64-bit LE

🔍 Miri

This crate runs successfully with Miri:

```bash MIRIFLAGS=-Zmiri-symbolic-alignment-check cargo +nightly miri test

for SEED in $(seq 0 10); do echo "Trying seed: $SEED" MIRIFLAGS="-Zmiri-seed=$SEED" cargo +nightly miri test || { echo "Failing seed: $SEED"; break; }; done ```

To check with different word size and endianness:

```bash

Big endian, 64-bit

cargo +nightly miri test --target mips64-unknown-linux-gnuabi64

Little endian, 32-bit

cargo +nightly miri test --target i686-unknown-linux-gnu ```

📦 Similar crates

arcstr: no inline repr, heavy slice (with dedicated Substr type) and custom Arc.
flexstr: no slice, very similar but use an Arc<str> instead of an Arc<String> (remove level of indirection but use fat pointers).
imstr: no inline repr, otherwise very similar.
and many more.

In short, HipStr, one string type to rule them all…

🚀 TODOs

More copy on write API (like imstr)?

📖 Author and licenses

For now, just me PoLazarus 👻 \ Help welcome! 🚨

MIT + APACHE

hipstr