[go: up one dir, main page]

Crate gratte

Crate gratte 

Source
Expand description

§gratte (a strum fork)

gratte is a fork of strum. It defines a set of macros and traits for working with enums and strings easier in Rust.

The full version of the README can be found on GitHub.

§Installing

Add gratte to your dependencies:

[dependencies]
gratte = "1.1.0"

or by running:

cargo add gratte

§Usage

gratte has the following derive macros:

MacroDescription
EnumStringConverts strings to enum variants based on their name.
DisplayConverts enum variants to strings
FromReprConvert from an integer to an enum.
AsRefStrImplement AsRef<str> for MyEnum
IntoStaticStrImplements From<MyEnum> for &'static str on an enum
EnumIterCreates a new type that iterates the variants of an enum.
EnumPropertyAdd custom properties to enum variants.
EnumMessageAdd a verbose message to enum variants.
EnumDiscriminantsGenerate a new type with only the discriminant names.
EnumCountAdd a constant usize equal to the number of variants.
VariantArrayAdds an associated VARIANTS constant which is an array of all enum discriminants
VariantNamesAdds an associated VARIANTS constant which is an array of discriminant names
EnumTableExperimental, creates a new type that stores an item of a specified type for each variant of the enum.

Modules§

additional_attributes
Documentation for Additional Attributes

Enums§

ParseError
The ParseError enum is a collection of all the possible reasons an enum can fail to parse from a string.

Traits§

AsStaticRefDeprecated
A cheap reference-to-reference conversion. Used to convert a value to a reference value with 'static lifetime within generic code.
EnumCount
A trait for capturing the number of variants in Enum. This trait can be autoderived by gratte_macros.
EnumMessage
Associates additional pieces of information with an Enum. This can be autoimplemented by deriving EnumMessage and annotating your variants with #[strum(message="...")].
EnumProperty
EnumProperty is a trait that makes it possible to store additional information with enum variants. This trait is designed to be used with the macro of the same name in the gratte_macros crate. Currently, the string, integer and bool literals are supported in attributes.
IntoDiscriminant
A trait for retrieving the enum generated by EnumDiscriminants from an associated Type on the original enumeration. This trait can be autoderived by gratte_macros.
IntoEnumIterator
This trait designates that an Enum can be iterated over. It can be auto generated using the EnumIter derive macro.
VariantArray
A trait for retrieving a static array containing all the variants in an Enum. This trait can be autoderived by gratte_macros. For derived usage, all the variants in the enumerator need to be unit-types, which means you can’t autoderive enums with inner data in one or more variants. Consider using it alongside EnumDiscriminants if you require inner data but still want to have an static array of variants.
VariantIterator
VariantMetadata
VariantNames
A trait for retrieving the names of each variant in Enum. This trait can be autoderived by gratte_macros.

Derive Macros§

AsRefStrderive
Converts enum variants to &'a str, where 'a is the lifetime of the input enum reference.
Displayderive
Converts enum variants to strings.
EnumCountderive
Add a constant usize equal to the number of variants.
EnumDiscriminantsderive
Generate a new type with only the discriminant names.
EnumIsderive
Generated is_*() methods for each variant. E.g. Color.is_red().
EnumIterderive
Creates a new type that iterates over the variants of an enum.
EnumMessagederive
Add a verbose message to an enum variant.
EnumPropertyderive
Add custom properties to enum variants.
EnumStringderive
Converts strings to enum variants based on their name.
EnumTryAsderive
Generated try_as_*() methods for all tuple-style variants. E.g. Message.try_as_write().
FromReprderive
Add a function to enum that allows accessing variants by its discriminant
IntoStaticStrderive
Implements From<MyEnum> for &'static str on an enum.
VariantArrayderive
Adds a 'static slice with all the Enum’s variants.
VariantNamesderive
Implements gratte::VariantNames which adds an associated constant VARIANTS which is a 'static slice of discriminant names.