danog/strum
1
0
Fork 0
mirror of https://github.com/danog/strum.git synced 2024-11-26 20:14:40 +01:00
Code Issues Projects Releases Wiki Activity

Merged changes from durka and updated docs accordinglt

Browse Source
This commit is contained in:
Peter Glotfelty 2017-02-15 18:31:19 -08:00
parent a1a871a8cc
commit 42ee963b37
4 changed files with 36 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -63,14 +63,14 @@ Strum has implemented the following macros:
/*
//The generated code will look like:
impl std::str::FromStr for Color {
type Err = strum::ParseError;
type Err = ::strum::ParseError;
fn from_str(s: &str) -> Result<Color, strum::ParseError> {
fn from_str(s: &str) -> ::std::result::Result<Color, Self::Error> {
match s {
"Red" => Ok(Color::Red),
"Green" => Ok(Color::Green { range:Default::default() }),
"blue" | "b" => Ok(Color::Blue(Default::default())),
_ => Err(strum::ParseError::VariantNotFound),
"Red" => ::std::result::Result::Ok(Color::Red),
"Green" => ::std::result::Result::Ok(Color::Green { range:Default::default() }),
"blue" | "b" => ::std::result::Result::Ok(Color::Blue(Default::default())),
_ => ::std::result::Result::Err(::strum::ParseError::VariantNotFound),
}
}
}
@ -136,19 +136,19 @@ Strum has implemented the following macros:
/*
// Generated code
impl EnumMessage for Color {
fn get_message(&self) -> Option<&str> {
impl ::strum::EnumMessage for Color {
fn get_message(&self) -> ::std::option::Option<&str> {
match self {
&Color::Red => Some("Red"),
&Color::Green {..} => Some("Simply Green"),
&Color::Red => ::std::option::Option::Some("Red"),
&Color::Green {..} => ::std::option::Option::Some("Simply Green"),
_ => None
}
}
fn get_detailed_message(&self) -> Option<&str> {
fn get_detailed_message(&self) -> ::std::option::Option<&str> {
match self {
&Color::Red => Some("This is very red"),
&Color::Green {..}=> Some("Simply Green"),
&Color::Red => ::std::option::Some("This is very red"),
&Color::Green {..}=> ::std::option::Some("Simply Green"),
_ => None
}
}
@ -271,6 +271,13 @@ fn main() {
}
```
# Contributing
Thanks for your interest in contributing. The project is divided into 3 parts, the traits are in the
`/strum` folder. The procedural macros are in the `/strum_macros` folder, and the integration tests are
in `/strum_tests`. Tests are still a work in progress, but they should be added in the test project to
verify that the macros are working correctly with the trait definitions.
# Debugging
To see the generated code, set the DEBUG_STRUM environment variable before compiling your code.

4
strum/Cargo.toml
View File

@ -1,6 +1,6 @@
[package]
name = "strum"
version = "0.1.0"
version = "0.2.0"
authors = ["Peter Glotfelty <peglotfe@microsoft.com>"]
license = "MIT"
@ -13,7 +13,7 @@ homepage = "https://github.com/Peternator7/strum"
readme = "../README.md"
[dev-dependencies]
strum_macros = "0.1.0"
strum_macros = "0.2.0"
[badges]
travis-ci = { repository = "Peternator7/strum" }

26
strum/src/lib.rs
View File

@ -63,15 +63,15 @@
//!
//! /*
//! //The generated code will look like:
//! impl std::str::FromStr for Color {
//! impl ::std::str::FromStr for Color {
//! type Err = strum::ParseError;
//!
//! fn from_str(s: &str) -> Result<Color, strum::ParseError> {
//! fn from_str(s: &str) -> Result<Color, Self::Error> {
//! match s {
//! "Red" => Ok(Color::Red),
//! "Green" => Ok(Color::Green { range:Default::default() }),
//! "blue" | "b" => Ok(Color::Blue(Default::default())),
//! _ => Err(strum::ParseError::VariantNotFound),
//! "Red" => ::std::result::Result::Ok(Color::Red),
//! "Green" => ::std::result::Result::Ok(Color::Green { range:Default::default() }),
//! "blue" | "b" => ::std::result::Result::Ok(Color::Blue(Default::default())),
//! _ => ::std::result::Result::Err(strum::ParseError::VariantNotFound),
//! }
//! }
//! }
@ -143,19 +143,19 @@
//!
//! /*
//! // Generated code
//! impl EnumMessage for Color {
//! fn get_message(&self) -> Option<&str> {
//! impl ::strum::EnumMessage for Color {
//! fn get_message(&self) -> ::std::option::Option<&str> {
//! match self {
//! &Color::Red => Some("Red"),
//! &Color::Green {..} => Some("Simply Green"),
//! &Color::Red => ::std::option::Option::Some("Red"),
//! &Color::Green {..} => ::std::option::Option::Some("Simply Green"),
//! _ => None
//! }
//! }
//!
//! fn get_detailed_message(&self) -> Option<&str> {
//! fn get_detailed_message(&self) -> ::std::option::Option<&str> {
//! match self {
//! &Color::Red => Some("This is very red"),
//! &Color::Green {..}=> Some("Simply Green"),
//! &Color::Red => ::std::option::Option::Some("This is very red"),
//! &Color::Green {..}=> ::std::option::Option::Some("Simply Green"),
//! _ => None
//! }
//! }

2
strum_macros/Cargo.toml
View File

@ -1,6 +1,6 @@
[package]
name = "strum_macros"
version = "0.1.0"
version = "0.2.0"
authors = ["Peter Glotfelty <peglotfe@microsoft.com>"]
license = "MIT"