tom/enumscribe
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update READMEs

Browse Source
This commit is contained in:
pantonshire committed 2023-02-08 11:45:37 +00:00
1 parent 830d5807a0
commit c47706bc5f
3 files changed
+39 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+1 -1
View File
@@ -11,7 +11,7 @@ Add to your Cargo.toml file:
```toml ```toml
[dependencies] [dependencies]
enumscribe = "0.1" enumscribe = "0.2"
``` ```
Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by
enumscribe/README.md
+19 -1
View File
@@ -11,7 +11,7 @@ Add to your Cargo.toml file:
```toml ```toml
[dependencies] [dependencies]
enumscribe = "0.1" enumscribe = "0.2"
``` ```
Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by
@@ -66,6 +66,24 @@ enum Website {
assert_eq!(Website::try_unscribe("GiThUb.CoM"), Some(Website::Github)); assert_eq!(Website::try_unscribe("GiThUb.CoM"), Some(Website::Github));
``` ```
The same attribute can be used on the enum itself to make all variants case-insensitive. Individual fields may opt back
in to case sensitivity with `#[enumscribe(case_sensitive)]`.
```rust
use enumscribe::TryUnscribe;
#[derive(TryUnscribe, PartialEq, Eq, Debug)]
#[case_insensitive]
enum Website {
#[enumscribe(str = "github.com")]
Github,
#[enumscribe(str = "crates.io")]
CratesDotIo,
}
assert_eq!(Website::try_unscribe("CrAtEs.Io"), Some(Website::CratesDotIo));
```
### "other" variant ### "other" variant
You can also have a variant which stores strings that could not be matched to any other variant. This is done using the You can also have a variant which stores strings that could not be matched to any other variant. This is done using the
`#[enumscribe(other)]` attribute. The variant should have a single field, which is a `String`. `#[enumscribe(other)]` attribute. The variant should have a single field, which is a `String`.
enumscribe_derive/README.md
+19 -1
View File
@@ -11,7 +11,7 @@ Add to your Cargo.toml file:
```toml ```toml
[dependencies] [dependencies]
enumscribe = "0.1" enumscribe = "0.2"
``` ```
Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by Derive macros and [`serde`](https://crates.io/crates/serde) support are enabled by default. They can be disabled by
@@ -66,6 +66,24 @@ enum Website {
assert_eq!(Website::try_unscribe("GiThUb.CoM"), Some(Website::Github)); assert_eq!(Website::try_unscribe("GiThUb.CoM"), Some(Website::Github));
``` ```
The same attribute can be used on the enum itself to make all variants case-insensitive. Individual fields may opt back
in to case sensitivity with `#[enumscribe(case_sensitive)]`.
```rust
use enumscribe::TryUnscribe;
#[derive(TryUnscribe, PartialEq, Eq, Debug)]
#[case_insensitive]
enum Website {
#[enumscribe(str = "github.com")]
Github,
#[enumscribe(str = "crates.io")]
CratesDotIo,
}
assert_eq!(Website::try_unscribe("CrAtEs.Io"), Some(Website::CratesDotIo));
```
### "other" variant ### "other" variant
You can also have a variant which stores strings that could not be matched to any other variant. This is done using the You can also have a variant which stores strings that could not be matched to any other variant. This is done using the
`#[enumscribe(other)]` attribute. The variant should have a single field, which is a `String`. `#[enumscribe(other)]` attribute. The variant should have a single field, which is a `String`.