https://github.com/twentyfourminutes/stringyenums
Provides a slim and fast way for mapping enums to strings in C#
https://github.com/twentyfourminutes/stringyenums
csharp csharp8 dotnet dotnet-core dotnetstandard enum enums enumstring fast mapping mapping-enums string string-matching
Last synced: 11 months ago
JSON representation
Provides a slim and fast way for mapping enums to strings in C#
- Host: GitHub
- URL: https://github.com/twentyfourminutes/stringyenums
- Owner: TwentyFourMinutes
- License: mit
- Created: 2020-01-05T22:05:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-29T07:28:40.000Z (about 5 years ago)
- Last Synced: 2025-01-18T05:42:45.581Z (about 1 year ago)
- Topics: csharp, csharp8, dotnet, dotnet-core, dotnetstandard, enum, enums, enumstring, fast, mapping, mapping-enums, string, string-matching
- Language: C#
- Homepage:
- Size: 87.9 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# StringyEnums
 
Provides a slim and fast way for mapping enums to strings and vice versa in C#. StringyEnums targets `.Net Standard 2.1`, `.Net Core 3.1` and `.Net Framework 4.8` so it's available to you on all platforms.
## About
This package brings a neat way to bind your enum members to a given string and vice versa. You can define it's value with simple attributes and query them by extension methods. This package prefers the runtime performance rather than memory consumption, anyhow it is _optimized at its best_ ™.
## Installation
You can either get this package by downloading it from the NuGet Package Manager built in Visual Studio, in the [releases](https://github.com/TwentyFourMinutes/StringyEnums/releases) tab or from the official [nuget.org](https://www.nuget.org/packages/StringyEnums) website.
Also you can install it via the **P**ackage **M**anager **C**onsole:
```
Install-Package StringyEnums
```
### Basic example
```c#
[Flags]
public enum FooEnum
{
[StringRepresentation("tofu")]
Foo = 1,
[StringRepresentation("strand bar")]
Bar = 2,
[StringRepresentation("tofu strand bar")]
FooBar = 4
}
EnumCore.Init(); // Put this at the start of your project
var firstResult = FooEnum.Foo.GetRepresentation();
Console.WriteLine(firstResult); // tofu
var secondResult = (FooEnum.Foo | FooEnum.Bar).GetFlagRepresentation();
foreach (var flag in secondResult)
{
Console.WriteLine(flag); // tofu, strand bar
}
var input = "strand bar";
var thridResult = input.GetEnumFromRepresentation();
Console.WriteLine(thridResult); // FooEnum.Bar
```
## How it works
StringyEnums is build upon a caching system under the hood, which is initialized at the start of the program, by calling `EnumCore.Init()`. This method adds all enums with a `StringRepresentation` to the cache which are in the same assembly that `EnumCore.Init()` called. Altough you can specify individual assemblies and enums which should be added to the internal cache.
Also note that this package is build on runtime performance on the `Release` build, which means that some methods might take for way longer than they do in reality. This is intended then the `Debug` build is not performing to much optimizing.
### Disclaimer
Every method has a `Try` implementation which are safe to use and don't throw exceptions. Only use the none `Try` implementations, if you are sure that the conversion, no matter which one, will be successful e.g. the enum exists.
Otherwise the method will throw a `KeyNotFoundException` which can have several reasons:
- The enum does not exist
- The enum isn't decorated with the `StringRepresentationAttribute`
- The enum wasn't added to the cache
- The enum doesn't implement a member with the required `StringRepresentationAttribute`
## Features
- C# 8.0 ready
- build upon runtime performance
- clean and simple to use
- thread save™
## Notes
If you feel like something is not working as intended or you are experiencing issues, feel free to create an issue. Also for feature requests just create an issue. For further information feel free to send me a [mail](mailto:office@twenty-four.dev) to `office@twenty-four.dev` or message me on Discord `24_minutes#7496`.