Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 2682937

Browse files
committed
update doc
1 parent c5efadb commit 2682937

File tree

6 files changed

+14
-17
lines changed

6 files changed

+14
-17
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "enum-ordinalize"
3-
version = "3.1.13"
3+
version = "3.1.15"
44
authors = ["Magic Len <[email protected]>"]
55
edition = "2021"
66
rust-version = "1.56"

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This crates provides a procedural macro to let enums not only get its variants'
1010
Use `#[derive(Ordinalize)]` to make an enum (which must only has unit variants) have `from_ordinal_unsafe`, `from_ordinal`, `variants`, and `variant_count` associated functions and a `ordinal` method.
1111

1212
```rust
13-
#[macro_use] extern crate enum_ordinalize;
13+
use enum_ordinalize::Ordinalize;
1414

1515
#[derive(Debug, PartialEq, Eq, Ordinalize)]
1616
enum MyEnum {
@@ -35,7 +35,7 @@ assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2i8) });
3535
### Get Variants
3636

3737
```rust
38-
#[macro_use] extern crate enum_ordinalize;
38+
use enum_ordinalize::Ordinalize;
3939

4040
#[derive(Debug, PartialEq, Eq, Ordinalize)]
4141
enum MyEnum {
@@ -57,7 +57,7 @@ The ordinal value is an integer whose size is determined by the enum itself. The
5757
For example,
5858

5959
```rust
60-
#[macro_use] extern crate enum_ordinalize;
60+
use enum_ordinalize::Ordinalize;
6161

6262
#[derive(Debug, PartialEq, Eq, Ordinalize)]
6363
enum MyEnum {
@@ -85,7 +85,7 @@ In order to store `1000`, the size of `MyEnum` grows. Thus, the ordinal is in `i
8585
You can use the `#[repr(type)]` attribute to control the size explicitly. For instance,
8686

8787
```rust
88-
#[macro_use] extern crate enum_ordinalize;
88+
use enum_ordinalize::Ordinalize;
8989

9090
#[derive(Debug, PartialEq, Eq, Ordinalize)]
9191
#[repr(usize)]
@@ -114,7 +114,7 @@ assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2usize) });
114114
The integers represented by variants are extended in successive increments and can be set explicitly from anywhere.
115115

116116
```rust
117-
#[macro_use] extern crate enum_ordinalize;
117+
use enum_ordinalize::Ordinalize;
118118

119119
#[derive(Debug, PartialEq, Eq, Ordinalize)]
120120
enum MyEnum {

src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This crates provides a procedural macro to let enums not only get its variants'
88
Use `#[derive(Ordinalize)]` to make an enum (which must only has unit variants) have `from_ordinal_unsafe`, `from_ordinal`, `variants`, and `variant_count` associated functions and a `ordinal` method.
99
1010
```rust
11-
#[macro_use] extern crate enum_ordinalize;
11+
use enum_ordinalize::Ordinalize;
1212
1313
#[derive(Debug, PartialEq, Eq, Ordinalize)]
1414
enum MyEnum {
@@ -33,7 +33,7 @@ assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2i8) });
3333
### Get Variants
3434
3535
```rust
36-
#[macro_use] extern crate enum_ordinalize;
36+
use enum_ordinalize::Ordinalize;
3737
3838
#[derive(Debug, PartialEq, Eq, Ordinalize)]
3939
enum MyEnum {
@@ -55,7 +55,7 @@ The ordinal value is an integer whose size is determined by the enum itself. The
5555
For example,
5656
5757
```rust
58-
#[macro_use] extern crate enum_ordinalize;
58+
use enum_ordinalize::Ordinalize;
5959
6060
#[derive(Debug, PartialEq, Eq, Ordinalize)]
6161
enum MyEnum {
@@ -83,7 +83,7 @@ In order to store `1000`, the size of `MyEnum` grows. Thus, the ordinal is in `i
8383
You can use the `#[repr(type)]` attribute to control the size explicitly. For instance,
8484
8585
```rust
86-
#[macro_use] extern crate enum_ordinalize;
86+
use enum_ordinalize::Ordinalize;
8787
8888
#[derive(Debug, PartialEq, Eq, Ordinalize)]
8989
#[repr(usize)]
@@ -112,7 +112,7 @@ assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2usize) });
112112
The integers represented by variants are extended in successive increments and can be set explicitly from anywhere.
113113
114114
```rust
115-
#[macro_use] extern crate enum_ordinalize;
115+
use enum_ordinalize::Ordinalize;
116116
117117
#[derive(Debug, PartialEq, Eq, Ordinalize)]
118118
enum MyEnum {

tests/tests.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#[macro_use]
2-
extern crate enum_ordinalize;
1+
use enum_ordinalize::Ordinalize;
32

43
#[test]
54
fn create_ordinalized_enum_1_1() {

tests/tests_128.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
#![allow(incomplete_features)]
33
#![feature(repr128)]
44

5-
#[macro_use]
6-
extern crate enum_ordinalize;
5+
use enum_ordinalize::Ordinalize;
76

87
#[test]
98
fn create_ordinalized_enum_4_3() {

tests/tests_advanced.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#[macro_use]
2-
extern crate enum_ordinalize;
1+
use enum_ordinalize::Ordinalize;
32

43
const FOUR: i8 = 4;
54

0 commit comments

Comments
 (0)