Provides the GetFields procedural macro.
The macro adds the get_fields constant to the struct the
macro is dervied on.
The get_fields contains the field names of the given
struct.
Note: The macro can only be derived from named structs.
* Usage * Attributes * Container Attributes * Rename all * Field Attributes * Skip * Visibility
You can derive the GetFields macro like this:
```rust use get_fields::GetFields;
struct Foo { bar: String, baz: String, bat: String, }
asserteq!(Foo::getfields, ["bar", "baz", "bat"]); ```
The GetFields macro supports the
get_fields attribute.
get_fields can be applied to the container or to a field
with different arguments listed below.
Container attributes are global attributes that change the behavior of the whole field names array, rather than that of a single field.
The rename_all attribute renames every field of the struct according
to the provided naming convention.
This attribute works exactly like the serde
equivalent.
Supported are these naming conventions:
- lowercase
- UPPERCASE
- PascalCase
- camelCase
- snake_case
- SCREAMING_SNAKE_CASE
- kebab-case
- SCREAMING-KEBAB-CASE
```rust use get_fields::GetFields;
struct Foo { fieldone: String, fieldtwo: String, field_three: String, }
asserteq!( Foo::getfields, ["FIELD-ONE", "FIELD-TWO", "FIELD-THREE"], ); ```
Note: Same as serde's implementation of rename_all, it is
assumed that your field names follow the rust naming convention, that
all field names must be given in snake_case.
If not, applying rename_all may result in unexpected field names.
Field attributes can be added to the fields of a named struct and change the behavior of a single field.
The skip attribute removes the field from get_fields.
```rust use get_fields::GetFields;
struct Foo { bar: String, baz: String, #[get_fields(skip)] bat: String, }
asserteq!(Foo::getfields, ["bar", "baz"]); ```
The visibility of the get_fields is the same as the
corresponding struct.
E.g. is it pub struct Foo { ... }, the get_fields
will be public as well.
This, for example, will work:
```rust mod foo { use get_fields::GetFields;
#[derive(GetFields)] pub(super) struct Foo { bar: String, baz: String, bat: String, } }
asserteq!(foo::Foo::getfields, ["bar", "baz", "bat"]); ```
Whereas this will not, since get_fields is private:
```compilefail mod foo { use getfields::GetFields;
#[derive(GetFields)] struct Foo { bar: String, baz: String, bat: String, } }
asserteq!(foo::Foo::getfields, ["bar", "baz", "bat"]); ```