ABorgna / string-newtype

Rust New Type idiom helper for string-like types

string-newtype: New Type idiom helper for string-like types

string-newtype is a helper library for using the newtype idiom with string-like types, including newtyped string slices.

Usage

Define an empty enum as a marker for your type, and add aliases based on it:

// A marker type, can be anything.
enum S {}

// The newtype definitions.
// `StringBuf` acts as a `String`, while `StringRef` acts as a `str`.
type SBuf = StringBuf<S>;
type SRef = StringRef<S>;

// Define functions that only accept the newtype.
fn my_func(owned: SBuf, reference: &SRef) {
    // ...
}

// Only the newtype can be passed to the function.
let s: SBuf = "hello".into();
my_func(s.clone(), &s);

The crate also defines SmolStrBuf and SmolStrRef types, which are newtypes for smol_str::SmolStr.

Features

• smol_str Enables newtypes for smol_str::SmolStrs.

• serde Enables serialization and deserialization implementations.

Developing string-newtype

See DEVELOPMENT.md for instructions on setting up the development environment.

License

This project is licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).