Crate nova[−][src]

Expand description

nova

Documentation

Create newtypes with great convenience.

All types generated by the following macros implement Debug, Clone, Eq, PartialEq, Ord, PartialOrd and Hash. For Copy types, the newtype also implements Copy.

For convenience, each type is also generated with a conditional derive for serde serialisation and deserialisation. This is enabled with the serde feature in your own crate, if desired.

Example

In this example, we create a PhoneNumber newtype wrapper around a string. We use the macro to generate the type, then implement a new function for creating it. The inner field of the newtype is only accessible from the same module, so this ensures that the type can only be created by methods designed to validate and assert that the type is valid.

// Creates the PhoneNumber newtype here.
nova::string!(PhoneNumber);

impl PhoneNumber {
    pub fn new(input: String) -> PhoneNumber {
        // An extremely poorly implemented phone number validator.
        assert_eq!(input.len(), 10);

        Self(input)
    }
}

fn blah() {
    let n = PhoneNumber::new("1234567890".to_string());
    let m = PhoneNumber::new("1234567890".to_string());
    let o = PhoneNumber::new("1234567891".to_string());
    assert_eq!(n, m);
    assert_ne!(n, o);
    assert!(n < o);
    
    // Deref to get a &str
    let _s: &str = &*n;

    // into_inner to take back the String
    let _s = n.into_inner();     
}

Features

  • std (default): use std library
  • uuid: add support for uuid::Uuid type
  • heapless: use heapless to provide Vec and String implementations

Usage in no_std environments

Usually you’ll want to enable heapless functionality when in a no_std environment. When declaring the crate in your Cargo.toml, do it like this:

nova = { version = "0.2", default-features = false, features = ["heapless"] }

License

This project is licensed under either of

at your option.

Macros

bytevecheapless

Creates a Vec<u8> newtype. With heapless feature enabled, creates a heapless::Vec<u8, N> newtype.

i8

Creates an i8 newtype.

i16

Creates an i16 newtype.

i32

Creates an i32 newtype.

i64

Creates an i64 newtype.

i128

Creates an i128 newtype.

isize

Creates an isize newtype.

newtype

Create a clonable newtype for a given type and name.

newtype_copy

Create a copiable newtype for a given type and name.

nonzero_i8

Creates a NonZeroI8 newtype.

nonzero_i16

Creates a NonZeroI16 newtype.

nonzero_i32

Creates a NonZeroI32 newtype.

nonzero_i64

Creates a NonZeroI64 newtype.

nonzero_i128

Creates a NonZeroI128 newtype.

nonzero_isize

Creates a NonZeroIsize newtype.

nonzero_u8

Creates a NonZeroU8 newtype.

nonzero_u16

Creates a NonZeroU16 newtype.

nonzero_u32

Creates a NonZeroU32 newtype.

nonzero_u64

Creates a NonZeroU64 newtype.

nonzero_u128

Creates a NonZeroU128 newtype.

nonzero_usize

Creates a NonZeroUsize newtype.

stringheapless

Creates a String newtype. With heapless feature enabled, creates a heapless::String<N> newtype.

u8

Creates a u8 newtype.

u16

Creates a u16 newtype.

u32

Creates a u32 newtype.

u64

Creates a u64 newtype.

u128

Creates a u128 newtype.

usize

Creates a usize newtype.

uuiduuid

Creates a uuid::Uuid newtype.