Enum SplitFlagsOptions
Provides options for splitting flags.
Namespace: Singulink.Enums
Assembly: Singulink.Enums.dll
Syntax
[Flags]
public enum SplitFlagsOptions
Fields
| Name | Description |
|---|---|
| AllMatchingFlags | Include all matching flags in the result, even if they are redundant. If this option is not specified, only the minimal set of flags that can be combined to form the original value are included. Methods that return split flags (e.g. SplitFlags<T>(T, SplitFlagsOptions) never include zero-value flags in the result regardless of this option.
Methods that convert flags to strings (e.g. AsString<T>(T, SplitFlagsOptions)) never return an empty string, so converting
a default value with no flags set will return the name of the zero value enumeration member (or |
| ExcludeRemainder | Exclude any remainder that cannot be represented by any defined flags from the result. This flag takes precedence over the ThrowOnRemainder flag if both are set. |
| None | Use the default options (no option flags set) when splitting flags. |
| SingleBitFlagsOnly | Indicates that only single-bit flags should be considered when splitting the value and multi-bit flags should be ignored. |
| ThrowOnRemainder | Throw ArgumentOutOfRangeException if there is a remainder that cannot be represented by any defined flags. |