Skip to main content

Enum

Describes the possible expectations for enum values.

Equality​

You can verify that the enum is equal to another one or not:

enum Colors { Red = 1, Green = 2, Blue = 3, Yellow = 4 }

await Expect.That(Colors.Red).IsEqualTo(Colors.Red)
  .Because("it is 'Red'");
await Expect.That(Colors.Red).IsNotEqualTo(Colors.Blue)
  .Because("it is 'Red'");

One of​

You can verify that the enum is one of many alternatives:

enum Colors { Red = 1, Green = 2, Blue = 3, Yellow = 4 }

await Expect.That(Colors.Red).IsOneOf(Colors.Red, Colors.Green, Colors.Blue);
await Expect.That(Colors.Yellow).IsNotOneOf(Colors.Red, Colors.Green, Colors.Blue);

Value​

You can verify that the enum has a given value or not:

enum Colors { Red = 1, Green = 2, Blue = 3, Yellow = 4 }

await Expect.That(Colors.Red).HasValue(1)
  .Because("'Red' is 1");
// or more explicit
await Expect.That(Colors.Red).HasValue().EqualTo(1)
  .Because("'Red' is 1");

await Expect.That(Colors.Red).HasValue().NotEqualTo(2)
  .Because("'Red' is 1");

The HasValue() continuation compares the underlying numeric value and supports the same comparisons as the other properties: EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo and Between.

Defined​

You can verify that the enum has a defined value or not:

enum Colors { Red = 1, Green = 2, Blue = 3, Yellow = 4 }

await Expect.That((Colors)3).IsDefined()
  .Because("3 corresponds to 'Blue'");
await Expect.That((Colors)4).IsNotDefined()
  .Because("4 is no valid color");

Flags​

You can verify that the enum has a specific flag or not:

RegexOptions subject = RegexOptions.Multiline | RegexOptions.IgnoreCase;

await Expect.That(subject).HasFlag(RegexOptions.IgnoreCase)
  .Because("it has the 'IgnoreCase' flag");
await Expect.That(subject).DoesNotHaveFlag(RegexOptions.ExplicitCapture)
  .Because("it does not have the 'ExplicitCapture' flag");

HasFlag is the one Has… expectation without a continuation: it asks whether a bit is set, not how two ordered values compare, so GreaterThan, Between and the rest would have no meaning for it.