10个版本

0.3.5 2024年8月13日
0.3.4 2024年8月8日
0.2.2 2024年8月4日
0.2.0 2024年7月23日
0.1.0 2024年2月17日

#9 in #isomorphism

Download history 5/week @ 2024-05-24 3/week @ 2024-05-31 120/week @ 2024-07-19 14/week @ 2024-07-26 695/week @ 2024-08-02 167/week @ 2024-08-09

996 每月下载
2 个crate中(通过 seoul)使用

MIT 许可证

32KB
558

Seoul-Rs

Crates.io docs.rs

  • Enum 数据类型 derive Isomorphism trait
  • StructEnum 数据类型 derive Tuplike trait
  • StructEnum 数据类型 derive Reflica trait
  • Enum 数据类型 derive IntoWrap trait

Isomorphism trait

  • 针对枚举数据类型。使用derive宏方便地转换枚举值。

  • 基本方法

    • fn title(&self) ->String;
    • fn list() -> Vec<Self>;
  • derive宏还实现了

    • Into<T> 对于 Self&Self
    • From<T>From<&T> 对于 Self(当实现 Default 且提供 "has_default" 语法时)

derive语法和回退

  • 当在变体级别未提供 title 时,将使用变体的名称(Ident)作为标题。
  • 当在顶级属性中未提供 list 时,将返回每个变体的默认格式的列表。
  • 当在变体级别未提供 into 值时,将在 <Into<T>> 特性中使用T类型的默认值。
  • 当类型实现了 Default 并在顶级属性中提供了 has_default,则 From<T>From<&T> 将为每个给定的类型 T 实现其中。

示例

use seoul::Isomorphism;

#[derive(PartialEq, Debug, Isomorphism)]
#[isomorphism(u8, list=[A, B(10)])]
enum ABC {
  #[into(0)] #[title("A")] A,
  #[into(1)] B(i32),
  C,
}

// `list()`
let list = ABC::list();
assert_eq!(list, vec![ABC::A, ABC::B(10)]);

let a: ABC = ABC::A;
let b = ABC::B(10);
let c = ABC::C;

// `title()`
assert_eq!(a.title(), "A");
assert_eq!(b.title(), "B");
assert_eq!(c.title(), "C");

// `Into<T>` for `&Self` and `Self`
assert_eq!(Into::<u8>::into(&a), 0);
assert_eq!(Into::<u8>::into(a), 0);
assert_eq!(Into::<u8>::into(&b), 1);
assert_eq!(Into::<u8>::into(c), 0);
#[derive(Default, Debug, Isomorphism, PartialEq)]
#[isomorphism(into=[u8, i8], has_default)]
pub enum CD {
  #[default] #[into([0, 1])] C,
  #[into([0, -1])] D,
}

// list
assert_eq!(CD::list(), vec![CD::C, CD::D]);

// Into
assert_eq!(Into::<u8>::into(CD::C), 0);
assert_eq!(Into::<i8>::into(CD::C), 1);
assert_eq!(Into::<u8>::into(CD::D), 0);
assert_eq!(Into::<i8>::into(CD::D), -1);

// From
assert_eq!(Into::<CD>::into(1i8), CD::C);
assert_eq!(Into::<CD>::into(-1i8), CD::D);
// fallback to default value of `CD`
assert_eq!(Into::<CD>::into(-0i8), CD::C);

特质 Tuplike

  • 用于 struct 数据类型。将 struct 数据转换为 tuple 格式

    • AB { a: 0, b: 10 } <=> (0, 10)
  • 使用 derive 宏,您可以实现

    • 特质 From<T>Self
    • 特质 Into<T>Self
    • 特质 Into<R>&Self
    • 在这里,T 是 struct 字段的 tuple 格式,
    • R 是它们的引用 tuple 格式。
  • 对于 enum 数据类型,将只为每个变体实现 From<T> 特质。

示例

use seoul::Tuplike;

#[derive(Debug, Clone, PartialEq, Tuplike)]
struct AB {
  a: u8, b: String
}

let tuple_: (u8, String) = (0, "string".to_string());
let ab_: AB = AB { a: 0, b: "string".to_string() };

let ab_into: (u8, String) = ab_.clone().into();
let tuple_into: AB = tuple_.clone().into();

assert_eq!(&ab_into, &tuple_);
assert_eq!(&tuple_into, &ab_);

let _ab_ref_into: (&u8, &String) = (&ab_).into();


// for enum, just `From<T>` will be implemented for each variant.
#[derive(Debug, Clone, PartialEq, Tuplike)]
enum ABC {
  A,
  B(String),
  C { a: i32, b: String }
}

let _ = ABC::A;

let b1: (String,) = ("string".to_string(),);
let b2: ABC = ABC::B("string".to_string());

let b1_: ABC = b1.clone().into();

assert_eq!(&b1_, &b2);

let c1: (i32, String) = (10, "string".to_string());
let c2: ABC = ABC::C { a: 10, b: "string".to_string() };
let c1_: ABC = c1.clone().into();

assert_eq!(&c1_, &c2);

特质 Reflica

  • 从原始 struct/enum 数据类型声明借用字段的 数据类型 ("reflica"),并为 reflica 实现 Into 特质。

  • reflica 的概念

    • 结构体 AB { a: u8, b:String} ->
      • 声明 struct RefAB<'a> { a: &'a u8, b: &'a String }
      • 实现 Into<RefAB<'a>> for &'a AB
    • 枚举 AB {A,B{a: u8,b: String } } ->
      • 声明 枚举 RefAB<'a> { A, B : { a: &'a u8, b: &'a String } }
      • 实现 Into<RefAB<'a>> for &'a AB

示例

use seoul::Reflica;

// struct
#[derive(Reflica)]
// attribute for derive implementation for the reflica 
#[reflica(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
struct AB<I> {
  a: u8,
  b: I
}

// RefAB delcared
let _: RefAB<String> = RefAB { a: &8, b: &String::from("ab") };

// check Into<RefAB> for &AB
let x = AB { a: 0, b: String::from("x")};
let _: RefAB<String> = (&x).into();

// check derive `Ord`
let a: RefAB<u8> = RefAB { a: &2, b: &10 };
let b: RefAB<u8> = RefAB { a: &2, b: &11 };
let c: RefAB<u8> = RefAB { a: &3, b: &10 };
let x = vec![a, b, c];
let mut y = x.clone();
y.sort();
assert_eq!(x, y);


// enum, use prefix other than basic `Ref`
#[derive(Reflica)]
// `prefix` attribute's string value will be used for reflica's prefix, other than the basic prefix `Ref`
#[reflica(Clone, Copy, Debug, prefix="Ref2")]
enum ABC<I> where I: Clone {
  A,
  B { a: u8, b: I },
  C(u8)
}

// Ref2AB delcared
let _: Ref2ABC<u8> = Ref2ABC::A;
let _: Ref2ABC<String> = Ref2ABC::B { a: &8, b: &String::from("ab") };

// check Into<Ref2AB>
let x = ABC::B { a: 0, b: String::from("x")};
let _: Ref2ABC<String> = (&x).into();

let x = ABC::<u8>::C(0);
let _: Ref2ABC<u8> = (&x).into();

Trait IntoWrap

  • 为枚举类型数据的每个变体实现 From 特性,其中当变体有一个未命名的字段时,将字段的数据转换成枚举数据。

  • 因此,每个变体不应有任何冗余的类型或泛型,以避免任何冲突的实现。

  • IntoWrap 可以被视为枚举包装变体的 Tuplike 的非元组单变量版本。

示例

use seoul::IntoWrap;

#[derive(Debug, Clone, PartialEq, IntoWrap)]
enum ABCD {
  A, // skip
  B(i32), // impl From<i32> for ABCD
  C { a: i32 }, // skip
  D(String) // impl From<String> for ABCD
}

let _ = ABCD::A;
let _ = ABCD::C { a: 10 };

let b: i32 = 10;
let b: ABCD = b.into();

let d = "string".to_string();
let d: ABCD = d.into();

assert_eq!(b, ABCD::B(10));
assert_eq!(d, ABCD::D("string".to_string()));


#[derive(Debug, Clone, PartialEq, IntoWrap)]
enum AB<X: Clone, Y> where Y: Clone {
  A((X, X)), // impl<X: Clone, Y> From<X, X> for AB where Y: Clone
  B(Vec<Y>) // impl<X: Clone, Y> From<Vec<X>> for AB where Y: Clone
}

let a: (String, String) = ("x".to_string(), "x".to_string());
let a: AB<String, i32> = a.into();

let b: Vec<i32> = vec![0, 1, 2];
let b: AB<String, i32> = b.into();

assert_eq!(a, AB::<String, i32>::A(("x".to_string(), "x".to_string())));
assert_eq!(b, AB::<String, i32>::B(vec![0, 1, 2]));


// This case won't work due to conflicting implementations.
/*#[derive(Debug, Clone, PartialEq, IntoWrap)]
enum AB<X: Clone, Y> where Y: Clone {
  A(X),
  B(Vec<Y>)
}*/

开发日志

- ver.0.2.0
  - `From<T>` implemented only with `has_default` attribute syntax when `Default` is implemented.
- ver 0.2.1~2
  - correct some typos

- ver 0.3.0
  - Add `Tuplike`.
- ver 0.3.1
  - Add an associated type `Tuple` to the trait `Tuplike`

- ver 0.3.2
  - Add `Reflica`

- ver 0.3.3
  - On `Tuplike`:
    - delete associated type `Tuple` from the trait.
    - derive macro now works on the enum type too: but only `From<T>` trait will be implemented for each variant.
  - Add `IntoWrap`

- ver 0.3.5
  - On `Isomorphism`:
    - Reinforced derive macro's generic parsing ability.
    - For struct type, the derive macro would only implement the Isormophism trait with each methods of it returning default values.

依赖关系

~240–680KB
~16K SLoC