strid-examples 10.0.0

Examples demonstrating usage of the `strid` crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! 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.
//!
//! Note: This example requires the `bytestring-facet` feature, which enables
//! facet's `bytestring` feature for `bytestring::ByteString` support.
//!
//! [`Bytes`]: https://docs.rs/bytes/*/bytes/struct.Bytes.html

#![allow(dead_code)]

#[cfg(feature = "bytestring-facet")]
use bytestring::ByteString;
#[cfg(feature = "bytestring-facet")]
use strid::braid;

/// 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
#[cfg(feature = "bytestring-facet")]
#[braid(
    serde,
    ref_doc = "A borrowed reference to a basic string slice wrapper"
)]
pub struct UsernameBuf(ByteString);