aliri_braid_examples 0.3.1

//! An example of constructing a basic strongly-typed wrapper around
//! a [`Bytes`]-backed value.
//!
//! The types in this module do not perform any validation or normalization
//! of their values, so every valid UTF-8 string is potentially valid for
//! these types.
//!
//! [`Bytes`]: https://docs.rs/bytes/*/bytes/struct.Bytes.html

use aliri_braid::braid;
use bytestring::ByteString;

/// A basic example of a wrapper around a [`Bytes`]
///
/// This type ends in _Buf_, so the borrowed form of this type
/// will be named [`Username`].
///
/// [`Bytes`]: https://docs.rs/bytes/*/bytes/struct.Bytes.html
#[braid(
    serde,
    ref_doc = "A borrowed reference to a basic string slice wrapper"
)]
pub struct UsernameBuf(ByteString);