RSCG – NetEscapades.EnumGenerators
RSCG – NetEscapades.EnumGenerators
| name | NetEscapades.EnumGenerators |
| nuget | https://www.nuget.org/packages/NetEscapades.EnumGenerators/ |
| link | https://andrewlock.net/netescapades-enumgenerators-a-source-generator-for-enum-performance/ |
| author | Andrew Lock |
Running fast tostring and other features for enum
This is how you can use NetEscapades.EnumGenerators .
The code that you start with is
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 | <Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>net7.0</TargetFramework> <ImplicitUsings>enable</ImplicitUsings> <Nullable>enable</Nullable> </PropertyGroup> <ItemGroup> <PackageReference Include="NetEscapades.EnumGenerators" Version="1.0.0-beta08" OutputItemType="Analyzer" ReferenceOutputAssembly="false" PrivateAssets="all" ExcludeAssets="comile;runtime" /> </ItemGroup> <PropertyGroup> <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> </PropertyGroup> </Project> |
The code that you will use is
01 02 03 04 05 06 07 08 09 10 11 12 13 | var value = InstallType.ShowGUI;Console.WriteLine($"the enum string is {value.ToStringFast()}");Console.WriteLine($"{InstallType.None.ToStringFast()}");var flags = AddToCoffee.Milk | AddToCoffee.Sugar;Console.WriteLine(flags.ToStringFast());Console.WriteLine($"HasFlag(Milk), {flags.HasFlagFast(AddToCoffee.Milk)}");Console.WriteLine($"HasFlag(Biscuit), {flags.HasFlagFast(AddToCoffee.Biscuit)}");//check also//InstallTypeExtensions.GetNames//AddToCoffeeExtensions.GetNames |
01 02 03 04 05 06 07 08 09 10 11 12 13 | using NetEscapades.EnumGenerators;using System.ComponentModel.DataAnnotations;using System.Xml.Linq;[EnumExtensions]internal enum InstallType{ [Display(Name = $"Please use one of the flags of {nameof(InstallType)}")] None= 0, ShowGUI, ShowNoGui,} |
01 02 03 04 05 06 07 08 09 10 11 | using NetEscapades.EnumGenerators;[EnumExtensions][Flags]internal enum AddToCoffee{ None= 0, Milk=1, Sugar=2, Biscuit=4} |
The code that is generated is
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | //------------------------------------------------------------------------------// <auto-generated>// This code was generated by the NetEscapades.EnumGenerators source generator//// Changes to this file may cause incorrect behavior and will be lost if// the code is regenerated.// </auto-generated>//------------------------------------------------------------------------------#nullable enable#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0using System;#endif /// <summary> /// Extension methods for <see cref="global::AddToCoffee" /> /// </summary> internal static partial class AddToCoffeeExtensions { /// <summary> /// The number of members in the enum. /// This is a non-distinct count of defined names. /// </summary> public const int Length = 4; /// <summary> /// Returns the string representation of the <see cref="global::AddToCoffee"/> value. /// If the attribute is decorated with a <c>[Display]</c> attribute, then /// uses the provided value. Otherwise uses the name of the member, equivalent to /// calling <c>ToString()</c> on <paramref name="value"/>. /// </summary> /// <param name="value">The value to retrieve the string value for</param> /// <returns>The string representation of the value</returns> public static string ToStringFast(this global::AddToCoffee value) => value switch { global::AddToCoffee.None => nameof(global::AddToCoffee.None), global::AddToCoffee.Milk => nameof(global::AddToCoffee.Milk), global::AddToCoffee.Sugar => nameof(global::AddToCoffee.Sugar), global::AddToCoffee.Biscuit => nameof(global::AddToCoffee.Biscuit), _ => value.ToString(), }; /// <summary> /// Determines whether one or more bit fields are set in the current instance. /// Equivalent to calling <see cref="global::System.Enum.HasFlag" /> on <paramref name="value"/>. /// </summary> /// <param name="value">The value of the instance to investigate</param> /// <param name="flag">The flag to check for</param> /// <returns><c>true</c> if the fields set in the flag are also set in the current instance; otherwise <c>false</c>.</returns> /// <remarks>If the underlying value of <paramref name="flag"/> is zero, the method returns true. /// This is consistent with the behaviour of <see cref="global::System.Enum.HasFlag" /></remarks> public static bool HasFlagFast(this global::AddToCoffee value, global::AddToCoffee flag) => flag == 0 ? true : (value & flag) == flag; /// <summary> /// Returns a boolean telling whether the given enum value exists in the enumeration. /// </summary> /// <param name="value">The value to check if it's defined</param> /// <returns><c>true</c> if the value exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(global::AddToCoffee value) => value switch { global::AddToCoffee.None => true, global::AddToCoffee.Milk => true, global::AddToCoffee.Sugar => true, global::AddToCoffee.Biscuit => true, _ => false, }; /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration. /// </summary> /// <param name="name">The name to check if it's defined</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(string name) => IsDefined(name, allowMatchingMetadataAttribute: false); /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration, /// or if a member decorated with a <c>[Display]</c> attribute /// with the required name exists. /// </summary> /// <param name="name">The name to check if it's defined</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value of metadata attributes,otherwise ignores them</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, or a member is decorated /// with a <c>[Display]</c> attribute with the name, <c>false</c> otherwise</returns> public static bool IsDefined(string name, bool allowMatchingMetadataAttribute) { return name switch { nameof(global::AddToCoffee.None) => true, nameof(global::AddToCoffee.Milk) => true, nameof(global::AddToCoffee.Sugar) => true, nameof(global::AddToCoffee.Biscuit) => true, _ => false, }; }#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0 /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration /// </summary> /// <param name="name">The name to check if it's defined</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(in ReadOnlySpan<char> name) => IsDefined(name, allowMatchingMetadataAttribute: false); /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration, /// or optionally if a member decorated with a <c>[Display]</c> attribute /// with the required name exists. /// Slower then the <see cref="IsDefined(string, bool)" /> overload, but doesn't allocate memory./> /// </summary> /// <param name="name">The name to check if it's defined</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value of metadata attributes,otherwise ignores them</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, or a member is decorated /// with a <c>[Display]</c> attribute with the name, <c>false</c> otherwise</returns> public static bool IsDefined(in ReadOnlySpan<char> name, bool allowMatchingMetadataAttribute) { return name switch { ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.None).AsSpan(), global::System.StringComparison.Ordinal) => true, ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Milk).AsSpan(), global::System.StringComparison.Ordinal) => true, ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Sugar).AsSpan(), global::System.StringComparison.Ordinal) => true, ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Biscuit).AsSpan(), global::System.StringComparison.Ordinal) => true, _ => false, }; }#endif /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The case-sensitive string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::AddToCoffee value) => TryParse(name, out value, false, false); /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::AddToCoffee value, bool ignoreCase) => TryParse(name, out value, ignoreCase, false); /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value included in metadata attributes such as /// <c>[Display]</c> attribute when parsing, otherwise only considers the member names.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::AddToCoffee value, bool ignoreCase, bool allowMatchingMetadataAttribute) { if (ignoreCase) { switch (name) { case string s when s.Equals(nameof(global::AddToCoffee.None), global::System.StringComparison.OrdinalIgnoreCase): value = global::AddToCoffee.None; return true; case string s when s.Equals(nameof(global::AddToCoffee.Milk), global::System.StringComparison.OrdinalIgnoreCase): value = global::AddToCoffee.Milk; return true; case string s when s.Equals(nameof(global::AddToCoffee.Sugar), global::System.StringComparison.OrdinalIgnoreCase): value = global::AddToCoffee.Sugar; return true; case string s when s.Equals(nameof(global::AddToCoffee.Biscuit), global::System.StringComparison.OrdinalIgnoreCase): value = global::AddToCoffee.Biscuit; return true; case string s when int.TryParse(name, out var val): value = (global::AddToCoffee)val; return true; default: value = default; return false; } } else { switch (name) { case nameof(global::AddToCoffee.None): value = global::AddToCoffee.None; return true; case nameof(global::AddToCoffee.Milk): value = global::AddToCoffee.Milk; return true; case nameof(global::AddToCoffee.Sugar): value = global::AddToCoffee.Sugar; return true; case nameof(global::AddToCoffee.Biscuit): value = global::AddToCoffee.Biscuit; return true; case string s when int.TryParse(name, out var val): value = (global::AddToCoffee)val; return true; default: value = default; return false; } } }#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0 /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::AddToCoffee value) => TryParse(name, out value, false, false); /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::AddToCoffee value, bool ignoreCase) => TryParse(name, out value, ignoreCase, false); /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::AddToCoffee" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="result">When this method returns, contains an object of type /// <see cref="global::AddToCoffee" /> whose /// value is represented by <paramref name="result"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::AddToCoffee" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value included in metadata attributes such as /// <c>[Display]</c> attribute when parsing, otherwise only considers the member names.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::AddToCoffee result, bool ignoreCase, bool allowMatchingMetadataAttribute) { if (ignoreCase) { switch (name) { case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.None).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::AddToCoffee.None; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Milk).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::AddToCoffee.Milk; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Sugar).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::AddToCoffee.Sugar; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Biscuit).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::AddToCoffee.Biscuit; return true; case ReadOnlySpan<char> current when int.TryParse(name, out var numericResult): result = (global::AddToCoffee)numericResult; return true; default: result = default; return false; } } else { switch (name) { case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.None).AsSpan(), global::System.StringComparison.Ordinal): result = global::AddToCoffee.None; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Milk).AsSpan(), global::System.StringComparison.Ordinal): result = global::AddToCoffee.Milk; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Sugar).AsSpan(), global::System.StringComparison.Ordinal): result = global::AddToCoffee.Sugar; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::AddToCoffee.Biscuit).AsSpan(), global::System.StringComparison.Ordinal): result = global::AddToCoffee.Biscuit; return true; case ReadOnlySpan<char> current when int.TryParse(name, out var numericResult): result = (global::AddToCoffee)numericResult; return true; default: result = default; return false; } } }#endif /// <summary> /// Retrieves an array of the values of the members defined in /// <see cref="global::AddToCoffee" />. /// Note that this returns a new array with every invocation, so /// should be cached if appropriate. /// </summary> /// <returns>An array of the values defined in <see cref="global::AddToCoffee" /></returns> public static global::AddToCoffee[] GetValues() { return new[] { global::AddToCoffee.None, global::AddToCoffee.Milk, global::AddToCoffee.Sugar, global::AddToCoffee.Biscuit, }; } /// <summary> /// Retrieves an array of the names of the members defined in /// <see cref="global::AddToCoffee" />. /// Note that this returns a new array with every invocation, so /// should be cached if appropriate. /// </summary> /// <returns>An array of the names of the members defined in <see cref="global::AddToCoffee" /></returns> public static string[] GetNames() { return new[] { nameof(global::AddToCoffee.None), nameof(global::AddToCoffee.Milk), nameof(global::AddToCoffee.Sugar), nameof(global::AddToCoffee.Biscuit), }; } } |
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | //------------------------------------------------------------------------------// <auto-generated>// This code was generated by the NetEscapades.EnumGenerators source generator//// Changes to this file may cause incorrect behavior and will be lost if// the code is regenerated.// </auto-generated>//------------------------------------------------------------------------------#nullable enable#if NETESCAPADES_ENUMGENERATORS_EMBED_ATTRIBUTESnamespace NetEscapades.EnumGenerators{ /// <summary> /// Add to enums to indicate that extension methods should be generated for the type /// </summary> [global::System.AttributeUsage(global::System.AttributeTargets.Enum)] [global::System.Diagnostics.Conditional("NETESCAPADES_ENUMGENERATORS_USAGES")]#if NET5_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage(Justification = "Generated by the NetEscapades.EnumGenerators source generator.")]#else [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]#endif public class EnumExtensionsAttribute : global::System.Attribute { /// <summary> /// The namespace to generate the extension class. /// If not provided the namespace of the enum will be used /// </summary> public string? ExtensionClassNamespace { get; set; } /// <summary> /// The name to use for the extension class. /// If not provided, the enum name with "Extensions" will be used. /// For example for an Enum called StatusCodes, the default name /// will be StatusCodesExtensions /// </summary> public string? ExtensionClassName { get; set; } }}#endif |
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | //------------------------------------------------------------------------------// <auto-generated>// This code was generated by the NetEscapades.EnumGenerators source generator//// Changes to this file may cause incorrect behavior and will be lost if// the code is regenerated.// </auto-generated>//------------------------------------------------------------------------------#nullable enable#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0using System;#endif /// <summary> /// Extension methods for <see cref="global::InstallType" /> /// </summary> internal static partial class InstallTypeExtensions { /// <summary> /// The number of members in the enum. /// This is a non-distinct count of defined names. /// </summary> public const int Length = 3; /// <summary> /// Returns the string representation of the <see cref="global::InstallType"/> value. /// If the attribute is decorated with a <c>[Display]</c> attribute, then /// uses the provided value. Otherwise uses the name of the member, equivalent to /// calling <c>ToString()</c> on <paramref name="value"/>. /// </summary> /// <param name="value">The value to retrieve the string value for</param> /// <returns>The string representation of the value</returns> public static string ToStringFast(this global::InstallType value) => value switch { global::InstallType.None => "Please use one of the flags of InstallType", global::InstallType.ShowGUI => nameof(global::InstallType.ShowGUI), global::InstallType.ShowNoGui => nameof(global::InstallType.ShowNoGui), _ => value.ToString(), }; /// <summary> /// Returns a boolean telling whether the given enum value exists in the enumeration. /// </summary> /// <param name="value">The value to check if it's defined</param> /// <returns><c>true</c> if the value exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(global::InstallType value) => value switch { global::InstallType.None => true, global::InstallType.ShowGUI => true, global::InstallType.ShowNoGui => true, _ => false, }; /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration. /// </summary> /// <param name="name">The name to check if it's defined</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(string name) => IsDefined(name, allowMatchingMetadataAttribute: false); /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration, /// or if a member decorated with a <c>[Display]</c> attribute /// with the required name exists. /// </summary> /// <param name="name">The name to check if it's defined</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value of metadata attributes,otherwise ignores them</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, or a member is decorated /// with a <c>[Display]</c> attribute with the name, <c>false</c> otherwise</returns> public static bool IsDefined(string name, bool allowMatchingMetadataAttribute) { var isDefinedInDisplayAttribute = false; if (allowMatchingMetadataAttribute) { isDefinedInDisplayAttribute = name switch { "Please use one of the flags of InstallType" => true, _ => false, }; } if (isDefinedInDisplayAttribute) { return true; } return name switch { nameof(global::InstallType.None) => true, nameof(global::InstallType.ShowGUI) => true, nameof(global::InstallType.ShowNoGui) => true, _ => false, }; }#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0 /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration /// </summary> /// <param name="name">The name to check if it's defined</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, <c>false</c> otherwise</returns> public static bool IsDefined(in ReadOnlySpan<char> name) => IsDefined(name, allowMatchingMetadataAttribute: false); /// <summary> /// Returns a boolean telling whether an enum with the given name exists in the enumeration, /// or optionally if a member decorated with a <c>[Display]</c> attribute /// with the required name exists. /// Slower then the <see cref="IsDefined(string, bool)" /> overload, but doesn't allocate memory./> /// </summary> /// <param name="name">The name to check if it's defined</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value of metadata attributes,otherwise ignores them</param> /// <returns><c>true</c> if a member with the name exists in the enumeration, or a member is decorated /// with a <c>[Display]</c> attribute with the name, <c>false</c> otherwise</returns> public static bool IsDefined(in ReadOnlySpan<char> name, bool allowMatchingMetadataAttribute) { var isDefinedInDisplayAttribute = false; if (allowMatchingMetadataAttribute) { isDefinedInDisplayAttribute = name switch { ReadOnlySpan<char> current when current.Equals("Please use one of the flags of InstallType".AsSpan(), global::System.StringComparison.Ordinal) => true, _ => false, }; } if (isDefinedInDisplayAttribute) { return true; } return name switch { ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.None).AsSpan(), global::System.StringComparison.Ordinal) => true, ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowGUI).AsSpan(), global::System.StringComparison.Ordinal) => true, ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowNoGui).AsSpan(), global::System.StringComparison.Ordinal) => true, _ => false, }; }#endif /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The case-sensitive string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::InstallType value) => TryParse(name, out value, false, false); /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::InstallType value, bool ignoreCase) => TryParse(name, out value, ignoreCase, false); /// <summary> /// Converts the string representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The string representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value included in metadata attributes such as /// <c>[Display]</c> attribute when parsing, otherwise only considers the member names.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif string? name, out global::InstallType value, bool ignoreCase, bool allowMatchingMetadataAttribute) { if (allowMatchingMetadataAttribute) { if (ignoreCase) { switch (name) { case string s when s.Equals("Please use one of the flags of InstallType", global::System.StringComparison.OrdinalIgnoreCase): value = global::InstallType.None; return true; default: break; }; } else { switch (name) { case "Please use one of the flags of InstallType": value = global::InstallType.None; return true; default: break; }; } } if (ignoreCase) { switch (name) { case string s when s.Equals(nameof(global::InstallType.None), global::System.StringComparison.OrdinalIgnoreCase): value = global::InstallType.None; return true; case string s when s.Equals(nameof(global::InstallType.ShowGUI), global::System.StringComparison.OrdinalIgnoreCase): value = global::InstallType.ShowGUI; return true; case string s when s.Equals(nameof(global::InstallType.ShowNoGui), global::System.StringComparison.OrdinalIgnoreCase): value = global::InstallType.ShowNoGui; return true; case string s when int.TryParse(name, out var val): value = (global::InstallType)val; return true; default: value = default; return false; } } else { switch (name) { case nameof(global::InstallType.None): value = global::InstallType.None; return true; case nameof(global::InstallType.ShowGUI): value = global::InstallType.ShowGUI; return true; case nameof(global::InstallType.ShowNoGui): value = global::InstallType.ShowNoGui; return true; case string s when int.TryParse(name, out var val): value = (global::InstallType)val; return true; default: value = default; return false; } } }#if NETCOREAPP && !NETCOREAPP2_0 && !NETCOREAPP1_1 && !NETCOREAPP1_0 /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::InstallType value) => TryParse(name, out value, false, false); /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="value">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="value"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::InstallType value, bool ignoreCase) => TryParse(name, out value, ignoreCase, false); /// <summary> /// Converts the span representation of the name or numeric value of /// an <see cref="global::InstallType" /> to the equivalent instance. /// The return value indicates whether the conversion succeeded. /// </summary> /// <param name="name">The span representation of the enumeration name or underlying value to convert</param> /// <param name="result">When this method returns, contains an object of type /// <see cref="global::InstallType" /> whose /// value is represented by <paramref name="result"/> if the parse operation succeeds. /// If the parse operation fails, contains the default value of the underlying type /// of <see cref="global::InstallType" />. This parameter is passed uninitialized.</param> /// <param name="ignoreCase"><c>true</c> to read value in case insensitive mode; <c>false</c> to read value in case sensitive mode.</param> /// <param name="allowMatchingMetadataAttribute">If <c>true</c>, considers the value included in metadata attributes such as /// <c>[Display]</c> attribute when parsing, otherwise only considers the member names.</param> /// <returns><c>true</c> if the value parameter was converted successfully; otherwise, <c>false</c>.</returns> public static bool TryParse(#if NETCOREAPP3_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif in ReadOnlySpan<char> name, out global::InstallType result, bool ignoreCase, bool allowMatchingMetadataAttribute) { if (allowMatchingMetadataAttribute) { if (ignoreCase) { switch (name) { case ReadOnlySpan<char> current when current.Equals("Please use one of the flags of InstallType".AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::InstallType.None; return true; default: break; }; } else { switch (name) { case ReadOnlySpan<char> current when current.Equals("Please use one of the flags of InstallType".AsSpan(), global::System.StringComparison.Ordinal): result = global::InstallType.None; return true; default: break; }; } } if (ignoreCase) { switch (name) { case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.None).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::InstallType.None; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowGUI).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::InstallType.ShowGUI; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowNoGui).AsSpan(), global::System.StringComparison.OrdinalIgnoreCase): result = global::InstallType.ShowNoGui; return true; case ReadOnlySpan<char> current when int.TryParse(name, out var numericResult): result = (global::InstallType)numericResult; return true; default: result = default; return false; } } else { switch (name) { case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.None).AsSpan(), global::System.StringComparison.Ordinal): result = global::InstallType.None; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowGUI).AsSpan(), global::System.StringComparison.Ordinal): result = global::InstallType.ShowGUI; return true; case ReadOnlySpan<char> current when current.Equals(nameof(global::InstallType.ShowNoGui).AsSpan(), global::System.StringComparison.Ordinal): result = global::InstallType.ShowNoGui; return true; case ReadOnlySpan<char> current when int.TryParse(name, out var numericResult): result = (global::InstallType)numericResult; return true; default: result = default; return false; } } }#endif /// <summary> /// Retrieves an array of the values of the members defined in /// <see cref="global::InstallType" />. /// Note that this returns a new array with every invocation, so /// should be cached if appropriate. /// </summary> /// <returns>An array of the values defined in <see cref="global::InstallType" /></returns> public static global::InstallType[] GetValues() { return new[] { global::InstallType.None, global::InstallType.ShowGUI, global::InstallType.ShowNoGui, }; } /// <summary> /// Retrieves an array of the names of the members defined in /// <see cref="global::InstallType" />. /// Note that this returns a new array with every invocation, so /// should be cached if appropriate. /// </summary> /// <returns>An array of the names of the members defined in <see cref="global::InstallType" /></returns> public static string[] GetNames() { return new[] { nameof(global::InstallType.None), nameof(global::InstallType.ShowGUI), nameof(global::InstallType.ShowNoGui), }; } } |
Code and pdf at
https://ignatandrei.github.io/RSCG_Examples/v2/docs/NetEscapades.EnumGenerators
Leave a Reply