Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 3.22 KB

README.md

File metadata and controls

59 lines (41 loc) · 3.22 KB

enumcapsulate

Crates.io Crates.io Crates.io docs.rs

Safe casting for newtype enums and their variants.


Traits

The enumcapsulate crate exports the following traits:

Traits Functionality
Encapsulate Umbrella derive macro for AsVariant, AsVariantMut, AsVariantRef, From, FromVariant, IntoVariant, TryInto, and VariantDowncast.
FromVariant Creates an instance of Self from the unambiguous field type of one of its variants.
IntoVariant Returns the current variant's field, consuming self.
AsVariant Provides owned access to the current variant's field.
AsVariantMut Provides mutable borrowed access to the current variant's field.
AsVariantRef Provides borrowed access to the current variant's field.
VariantDowncast Convenience umbrella trait utilizing AsVariant, AsVariantRef, AsVariantMut, and IntoVariant.
VariantDiscriminant Used to obtain an enum variant's discriminant.

Derive macros

The enumcapsulate crate exports the following corresponding derive macros, if the "derive" feature is enabled (which is the default):

  • Encapsulate
  • From
  • TryInto
  • FromVariant
  • IntoVariant
  • AsVariant
  • AsVariantMut
  • AsVariantRef
  • VariantDowncast
  • VariantDiscriminant

Find more information on above derive macros in enumcapsulate-macros's own README file.

Documentation

Please refer to the documentation on docs.rs.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct,
and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MPL-2.0 – see the LICENSE.md file for details.