Lib.rs

整数清理器

整数验证器

整数可派生特性

以下是可以为基于整型的类型推导出的特性：Debug、Clone、Copy、PartialEq、Eq、PartialOrd、Ord、FromStr、AsRef、Deref、Into、From、TryFrom、Hash、Borrow、Display、Default、Serialize、Deserialize。

浮点数

浮点数内部类型包括：f32、f64。

浮点数清理器

浮点数验证器

浮点数可推导特性

以下是可以为基于浮点数的类型推导出的特性：Debug、Clone、Copy、PartialEq、Eq、PartialOrd、Ord、FromStr、AsRef、Deref、Into、From、TryFrom、Hash、Borrow、Display、Default、Serialize、Deserialize。

如果验证规则保证了排除NaN，则还可以推导出Eq和Ord。这可以通过应用finite验证来实现。例如

#[nutype(
    validate(finite),
    derive(PartialEq, Eq, PartialOrd, Ord),
)]
struct Size(f64);

其他内部类型和泛型

对于任何其他类型，都可以使用with定义自定义清理器，并使用predicate定义自定义验证器。

use nutype::nutype;

#[nutype(
    derive(Debug, PartialEq, AsRef, Deref),
    sanitize(with = |mut guests| { guests.sort(); guests }),
    validate(predicate = |guests| !guests.is_empty() ),
)]
pub struct GuestList(Vec<String>);

也可以使用泛型

#[nutype(
    sanitize(with = |mut v| { v.sort(); v }),
    validate(predicate = |vec| !vec.is_empty()),
    derive(Debug, PartialEq, AsRef, Deref),
)]
struct SortedNotEmptyVec<T: Ord>(Vec<T>);

let wise_friends = SortedNotEmptyVec::try_new(vec!["Seneca", "Zeno", "Plato"]).unwrap();
assert_eq!(wise_friends.as_ref(), &["Plato", "Seneca", "Zeno"]);
assert_eq!(wise_friends.len(), 3);

let numbers = SortedNotEmptyVec::try_new(vec![4, 2, 7, 1]).unwrap();
assert_eq!(numbers.as_ref(), &[1, 2, 4, 7]);
assert_eq!(numbers.len(), 4);

自定义清理器

可以使用with选项设置自定义清理器。自定义清理器是一个接收内部类型值的所有权和返回清理后值的函数或闭包。

例如，这个

#[nutype(sanitize(with = new_to_old))]
pub struct CityName(String);

fn new_to_old(s: String) -> String {
    s.replace("New", "Old")
}

等于以下这个

#[nutype(sanitize(with = |s| s.replace("New", "Old") ))]
pub struct CityName(String);

并且工作方式相同

let city = CityName::new("New York");
assert_eq!(city.into_inner(), "Old York");

自定义验证器

以类似的方式可以定义自定义验证器，但验证函数接收一个引用并返回bool。将其视为谓词。

#[nutype(validate(predicate = is_valid_name))]
pub struct Name(String);

fn is_valid_name(name: &str) -> bool {
    // A fancy way to verify if the first character is uppercase
    name.chars().next().map(char::is_uppercase).unwrap_or(false)
}

食谱

推导Default

#[nutype(
    derive(Default),
    default = "Anonymous",
)]
pub struct Name(String);

在浮点类型上推导Eq和Ord

使用nutype，如果设置了finite验证，则可以推导出Eq和Ord。finite验证确保有效的值排除NaN。

#[nutype(
    validate(finite),
    derive(PartialEq, Eq, PartialOrd, Ord),
)]
pub struct Weight(f64);

使用 new_unchecked 破坏约束

虽然不鼓励，但可以通过启用new_unchecked crate功能并将类型标记为new_unchecked来绕过约束

#[nutype(
    new_unchecked,
    sanitize(trim),
    validate(len_char_min = 8)
)]
pub struct Name(String);

// Yes, you're forced to use `unsafe` here, so everyone will point fingers at YOU.
let name = unsafe { Name::new_unchecked(" boo ".to_string()) };

// `name` violates the sanitization and validation rules!!!
assert_eq!(name.into_inner(), " boo ");

功能标志

• arbitrary - 启用派生 arbitrary::Arbitrary。
• new_unchecked - 启用生成不安全的 ::new_unchecked() 函数。
• regex - 允许在基于字符串的类型上使用 regex = 验证。注意：您的crate还必须在依赖项中显式包含 regex 和 lazy_static。
• serde - 与 serde crate 集成。允许派生 Serialize 和 Deserialize 特性。
• schemars08 - 允许派生 JsonSchema 特性，来自 schemars crate。注意，目前验证规则不被遵守。
• std - 默认启用。使用 default-features = false 禁用。

何时 nutype 适合您？

• 如果您喜欢 newtype 模式，并且您喜欢利用Rust类型系统来强制执行业务逻辑的正确性。
• 如果您想使用类型系统来保持不变性
• 如果您是DDD爱好者，nutype是使您的领域模型更具表达力的绝佳助手。
• 您希望在保证质量的同时快速原型化。

何时 nutype 不太适合？

• 您非常关心编译时间（nutype依赖于proc宏的重度使用）。
• 您认为元编程太过于隐秘的魔法。
• IDE可能无法很好地为您提供关于proc宏的提示。
• nutype的设计可能迫使您执行不必要的验证（例如，从数据库加载数据时），这可能会对您追求极端性能的目标产生负面影响。

支持乌克兰军队

今天我住在柏林，我有幸过着身体安全的 生活。但我是一名乌克兰人。我生命的前25年在乌克兰第二大城市 哈尔科夫 度过，离俄罗斯边界有60公里。今天大约 三分之一的我的家乡被俄国人摧毁。我的父母、亲戚和朋友们不得不在炮击和空袭中生存，在地下室里生活了一个多月。

其中一些人设法逃到了欧盟。其他人正在哈尔科夫尝试过着“正常的生活”，在那里履行日常职责。还有一些人现在正在前线，每秒钟都冒着生命危险保护其他人。

我鼓励您向 谢尔盖·普里图拉慈善基金会 捐款。只需选择您喜欢的项目并进行捐赠即可。这是最知名的基金会之一，您可以观看一个 简短的纪录片 了解它。您对乌克兰军队的贡献是对我平静的捐献，这样我可以有更多的时间开发这个项目。

谢谢。

类似项目

• prae - 一个非常相似的crate，旨在解决相同的问题，但采用略有不同的方法。
• bounded-integer - Rust的有限整数。
• refinement - 基于泛型的类型安全精炼类型的便捷创建。
• semval - Rust的语义验证。
• validator - Rust结构体的简单验证（由宏驱动）。

许可证

MIT © 谢尔盖·波塔波夫