Table of Contents

HourSet Struct

Definition

Namespace
Bodu
Assembly
Bodu.Core.dll
Package
Bodu.Core 1.3.0
Source
HourSet.Enumerator.cs

Represents an immutable set of hours of the day, 0 to 23.

public readonly struct HourSet : ICalendarValueSet<HourSet, int>, IEquatable<HourSet>, IEqualityOperators<HourSet, HourSet, bool>, IBitwiseOperators<HourSet, HourSet, HourSet>, ISpanParsable<HourSet>, IParsable<HourSet>, IUtf8SpanParsable<HourSet>, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEnumerable<int>, IEnumerable
Implements
Inherited Members
Extension Methods

Examples

var selected = new HourSet(9, 10, 11, 12, 13, 14, 15, 16, 17);
HourSet parsed = HourSet.Parse("9-17");

bool due = selected.Contains(DateTime.Now.Hour);
bool same = selected == parsed; // true

Remarks

An HourSet holds one bit per hour, so it never allocates, and testing, adding or removing an hour, or combining two sets with |, &, ^ and ~, is a single bitwise operation. Contains(int) answers false for any value outside 0 to 23 rather than throwing, which keeps a membership test against Hour to a comparison and a bit test.

The text form lists the hours in ascending order, separated by commas, each run of two or more consecutive hours written as an inclusive range, so "9-17" selects nine to five. The empty set is the empty string. Parse(string) reads any list of values and ranges in that form, in any order, and ToString() writes the canonical one. ToString(string?) also writes every hour without ranges, or a binary form with one character per hour, and Parse(string) and ParseExact(string, string) read them back. TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?) writes the same text into a span of characters, its other overload into a span of UTF-8 bytes, and the span and UTF-8 overloads of Parse, TryParse, ParseExact and TryParseExact read it.

ToUInt64() and FromUInt64(ulong) expose the bits directly: bit n selects hour n.

Constructors

HourSet(params int[]?)

Initializes a new instance of the HourSet struct that selects the specified hours.

public HourSet(params int[]? hours)

Parameters

hours int[]

The hours to select, or null for none.

Remarks

An hour may appear more than once, and the order is immaterial.

Exceptions

ArgumentOutOfRangeException

Thrown when a value in hours is less than 0 or greater than 23.

Properties

Count

Gets the number of hours the set selects.

public int Count { get; }

Property Value

int

A number from 0 to 24.

Methods

Contains(int)

Determines whether the set selects the specified hour.

public bool Contains(int hour)

Parameters

hour int

The hour to test.

Returns

bool

true when the set selects hour; false when it does not, including when hour is outside 0 to 23.

Equals(HourSet)

Determines whether this set selects the same hours as another.

public bool Equals(HourSet other)

Parameters

other HourSet

The set to compare with.

Returns

bool

true when the sets are equal; otherwise false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetEnumerator()

Returns an enumerator that yields the selected hours in ascending order without allocating.

public HourSet.Enumerator GetEnumerator()

Returns

HourSet.Enumerator

An enumerator over the selected hours.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Parse(ReadOnlySpan<byte>)

Converts UTF-8 text in one of the forms ToString(string?, IFormatProvider?) writes into a HourSet, detecting the form.

public static HourSet Parse(ReadOnlySpan<byte> utf8Text)

Parameters

utf8Text ReadOnlySpan<byte>

The UTF-8 text to convert.

Returns

HourSet

The set the text describes.

Remarks

The text is decoded and read as Parse(string) reads a string.

Exceptions

FormatException

Thrown when utf8Text is not valid UTF-8, or is neither the binary form nor a list of values and ranges from 0 to 23.

Parse(ReadOnlySpan<char>)

Converts a span of characters in one of the forms ToString(string?, IFormatProvider?) writes into a HourSet, detecting the form.

public static HourSet Parse(ReadOnlySpan<char> s)

Parameters

s ReadOnlySpan<char>

The characters to convert.

Returns

HourSet

The set the characters describe.

Remarks

The characters are read as Parse(string) reads a string.

Exceptions

FormatException

Thrown when s is neither the binary form nor a list of values and ranges from 0 to 23.

Parse(string)

Converts text in one of the forms ToString(string?, IFormatProvider?) writes into a HourSet, detecting the form.

public static HourSet Parse(string s)

Parameters

s string

The text to convert, such as "9-17".

Returns

HourSet

The set the text describes.

Remarks

A text of exactly 24 characters, each 0 or 1, is the binary form, hour 0 first. Any other text is a comma-separated list of hours and inclusive ranges: whitespace around the list and around each value is ignored, an empty or blank string is the empty set, values are unsigned decimal integers, a range a-b needs a no greater than b, and values may repeat or overlap.

The binary test comes first and reads the text as given, so text made only of 0 and 1 is a list only when it is not 24 characters long. ParseExact(string, string) with the "G" format reads any text as a list.

Exceptions

ArgumentNullException

Thrown when s is null.

FormatException

Thrown when s is neither the binary form nor a list of values and ranges from 0 to 23.

ToString()

Returns the canonical text form of the set: the selected hours in ascending order, separated by commas, each run of two or more consecutive hours written as an inclusive range.

public override string ToString()

Returns

string

The text form, such as "9-17", or the empty string for the empty set.

ToString(string?)

Returns the set as text in the specified format.

public string ToString(string? format)

Parameters

format string

The format, or null or empty for the default.

Returns

string

The text.

Remarks

The formats are described at ToString(string?, IFormatProvider?).

Exceptions

FormatException

Thrown when format is not a supported format.

ToString(string?, IFormatProvider?)

Returns the set as text in the specified format.

public string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

The format, or null or empty for the default.

formatProvider IFormatProvider

Ignored; the text does not depend on culture.

Returns

string

The text.

Remarks

The formats, whose letters are read in either case, are:

FormatText
G, the default The hours in ascending order, separated by commas, each run of two or more consecutive hours as an inclusive range: "9-17".
LEvery selected hour listed, without ranges: "9,10,11,12,13,14,15,16,17".
B, 0, 1, 01 Binary, one character per hour from 0 to 23, 0 first, with 1 for a selected hour: "000000000111111111000000".

Exceptions

FormatException

Thrown when format is not a supported format.

ToUInt64()

Returns the set's bits, bit n selecting hour n.

public ulong ToUInt64()

Returns

ulong

The bits, with nothing set above bit 23.

TryFormat(Span<byte>, out int, ReadOnlySpan<char>, IFormatProvider?)

Attempts to write the set as UTF-8 text in the specified format into a span of bytes.

public bool TryFormat(Span<byte> utf8Destination, out int bytesWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = null)

Parameters

utf8Destination Span<byte>

The span to write to.

bytesWritten int

When this method returns true, the number of bytes written; otherwise 0.

format ReadOnlySpan<char>

The format, or an empty span for the default.

provider IFormatProvider

Ignored; the text does not depend on culture.

Returns

bool

true when the text fits in utf8Destination; otherwise false, and utf8Destination is left unchanged.

Remarks

The text is the one ToString(string?, IFormatProvider?) returns for the same format. It is ASCII, so each character is one byte.

Exceptions

FormatException

Thrown when format is not a supported format.

TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?)

Attempts to write the set as text in the specified format into a span of characters.

public bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = null)

Parameters

destination Span<char>

The span to write to.

charsWritten int

When this method returns true, the number of characters written; otherwise 0.

format ReadOnlySpan<char>

The format, or an empty span for the default.

provider IFormatProvider

Ignored; the text does not depend on culture.

Returns

bool

true when the text fits in destination; otherwise false, and destination is left unchanged.

Remarks

The text is the one ToString(string?, IFormatProvider?) returns for the same format.

Exceptions

FormatException

Thrown when format is not a supported format.

TryParse(ReadOnlySpan<byte>, out HourSet)

Attempts to convert UTF-8 text in one of the forms ToString(string?, IFormatProvider?) writes into an HourSet, detecting the form.

public static bool TryParse(ReadOnlySpan<byte> utf8Text, out HourSet result)

Parameters

utf8Text ReadOnlySpan<byte>

The UTF-8 text to convert.

result HourSet

When this method returns true, the set the text describes; otherwise Empty.

Returns

bool

true when utf8Text is valid UTF-8 for the binary form or a list of values and ranges from 0 to 23; otherwise false.

Remarks

The text is decoded and read as Parse(string) reads a string.

TryParse(ReadOnlySpan<char>, out HourSet)

Attempts to convert a span of characters in one of the forms ToString(string?, IFormatProvider?) writes into an HourSet, detecting the form.

public static bool TryParse(ReadOnlySpan<char> s, out HourSet result)

Parameters

s ReadOnlySpan<char>

The characters to convert.

result HourSet

When this method returns true, the set the characters describe; otherwise Empty.

Returns

bool

true when s is the binary form or a list of values and ranges from 0 to 23; otherwise false.

Remarks

The characters are read as Parse(string) reads a string.

TryParse(string?, out HourSet)

Attempts to convert text in one of the forms ToString(string?, IFormatProvider?) writes into a HourSet, detecting the form.

public static bool TryParse(string? s, out HourSet result)

Parameters

s string

The text to convert, such as "9-17".

result HourSet

When this method returns true, the set the text describes; otherwise Empty.

Returns

bool

true when s is the binary form or a list of values and ranges from 0 to 23; otherwise false.

Remarks

The text is read as Parse(string) reads it.

With(int)

Returns a set that also selects the specified hour.

public HourSet With(int hour)

Parameters

hour int

The hour to add.

Returns

HourSet

A set that selects hour and every hour this set selects.

Exceptions

ArgumentOutOfRangeException

Thrown when hour is less than 0 or greater than 23.

Without(int)

Returns a set that no longer selects the specified hour.

public HourSet Without(int hour)

Parameters

hour int

The hour to remove.

Returns

HourSet

A set that selects every hour this set selects except hour.

Exceptions

ArgumentOutOfRangeException

Thrown when hour is less than 0 or greater than 23.

Explicit Interface Implementations

All

Gets the set that selects every hour from 0 to 23.

static HourSet All { get; }

Returns

HourSet

Empty

Gets the set that selects no hour.

static HourSet Empty { get; }

Returns

HourSet

FromUInt64(ulong)

Creates a set from its bits, bit n selecting hour n.

static HourSet FromUInt64(ulong bits)

Parameters

bits ulong

The bits.

Returns

HourSet

The set that bits describe.

Exceptions

ArgumentOutOfRangeException

Thrown when bits sets a bit above bit 23, which selects no hour.

ParseExact(ReadOnlySpan<char>, ReadOnlySpan<char>)

Converts a span of characters in the specified format into an HourSet.

static HourSet ParseExact(ReadOnlySpan<char> s, ReadOnlySpan<char> format)

Parameters

s ReadOnlySpan<char>

The characters to convert.

format ReadOnlySpan<char>

The format of s, one of those ToString(string?) writes.

Returns

HourSet

The set the characters describe.

Remarks

The characters are read as ParseExact(string, string) reads a string.

Exceptions

FormatException

Thrown when format is not a supported format, or s is not text in that format.

ParseExact(string, string)

Converts text in the specified format into an HourSet.

static HourSet ParseExact(string s, string format)

Parameters

s string

The text to convert.

format string

The format of s, one of those ToString(string?) writes.

Returns

HourSet

The set the text describes.

Remarks

"G" reads a list of values and ranges as Parse(string) reads one, "L" a list of values without ranges, and "B", "0", "1" or "01" the binary form alone, 24 characters with no whitespace. The format letters are read in either case.

Exceptions

ArgumentNullException

Thrown when s or format is null.

FormatException

Thrown when format is not a supported format, or s is not text in that format.

IEnumerable<int>.GetEnumerator()

Returns an enumerator that iterates through the collection.

IEnumerator<int> IEnumerable<int>.GetEnumerator()

Returns

IEnumerator<int>

An enumerator that can be used to iterate through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

IParsable<HourSet>.Parse(string, IFormatProvider)

Parses a string into a value.

static HourSet IParsable<HourSet>.Parse(string s, IFormatProvider provider)

Parameters

s string

The string to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about s.

Returns

HourSet

The result of parsing s.

Exceptions

ArgumentNullException

s is null.

FormatException

s is not in the correct format.

OverflowException

s is not representable by HourSet.

IParsable<HourSet>.TryParse(string, IFormatProvider, out HourSet)

Tries to parse a string into a value.

static bool IParsable<HourSet>.TryParse(string s, IFormatProvider provider, out HourSet result)

Parameters

s string

The string to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about s.

result HourSet

When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

bool

true if s was successfully parsed; otherwise, false.

ISpanParsable<HourSet>.Parse(ReadOnlySpan<char>, IFormatProvider)

Parses a span of characters into a value.

static HourSet ISpanParsable<HourSet>.Parse(ReadOnlySpan<char> s, IFormatProvider provider)

Parameters

s ReadOnlySpan<char>

The span of characters to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about s.

Returns

HourSet

The result of parsing s.

Exceptions

FormatException

s is not in the correct format.

OverflowException

s is not representable by HourSet.

ISpanParsable<HourSet>.TryParse(ReadOnlySpan<char>, IFormatProvider, out HourSet)

Tries to parse a span of characters into a value.

static bool ISpanParsable<HourSet>.TryParse(ReadOnlySpan<char> s, IFormatProvider provider, out HourSet result)

Parameters

s ReadOnlySpan<char>

The span of characters to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about s.

result HourSet

When this method returns, contains the result of successfully parsing s, or an undefined value on failure.

Returns

bool

true if s was successfully parsed; otherwise, false.

IUtf8SpanParsable<HourSet>.Parse(ReadOnlySpan<byte>, IFormatProvider)

Parses a span of UTF-8 characters into a value.

static HourSet IUtf8SpanParsable<HourSet>.Parse(ReadOnlySpan<byte> utf8Text, IFormatProvider provider)

Parameters

utf8Text ReadOnlySpan<byte>

The span of UTF-8 characters to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about utf8Text.

Returns

HourSet

The result of parsing utf8Text.

Exceptions

FormatException

utf8Text is not in the correct format.

OverflowException

utf8Text is not representable by HourSet.

IUtf8SpanParsable<HourSet>.TryParse(ReadOnlySpan<byte>, IFormatProvider, out HourSet)

Tries to parse a span of UTF-8 characters into a value.

static bool IUtf8SpanParsable<HourSet>.TryParse(ReadOnlySpan<byte> utf8Text, IFormatProvider provider, out HourSet result)

Parameters

utf8Text ReadOnlySpan<byte>

The span of UTF-8 characters to parse.

provider IFormatProvider

An object that provides culture-specific formatting information about utf8Text.

result HourSet

On return, contains the result of successfully parsing utf8Text or an undefined value on failure.

Returns

bool

true if utf8Text was successfully parsed; otherwise, false.

TryParseExact(ReadOnlySpan<char>, ReadOnlySpan<char>, out HourSet)

Attempts to convert a span of characters in the specified format into an HourSet.

static bool TryParseExact(ReadOnlySpan<char> s, ReadOnlySpan<char> format, out HourSet result)

Parameters

s ReadOnlySpan<char>

The characters to convert.

format ReadOnlySpan<char>

The format of s, one of those ToString(string?) writes.

result HourSet

When this method returns true, the set the characters describe; otherwise Empty.

Returns

bool

true when format is a supported format and s is text in it; otherwise false.

Remarks

The characters are read as ParseExact(string, string) reads a string.

TryParseExact(string?, string?, out HourSet)

Attempts to convert text in the specified format into an HourSet.

static bool TryParseExact(string? s, string? format, out HourSet result)

Parameters

s string

The text to convert.

format string

The format of s, one of those ToString(string?) writes.

result HourSet

When this method returns true, the set the text describes; otherwise Empty.

Returns

bool

true when format is a supported format and s is text in it; otherwise false.

Remarks

The text is read as ParseExact(string, string) reads it.

operator &(HourSet, HourSet)

Returns the hours that both sets select.

static HourSet operator &(HourSet left, HourSet right)

Parameters

left HourSet

The first set.

right HourSet

The second set.

Returns

HourSet

The intersection of left and right.

operator |(HourSet, HourSet)

Returns the hours that either set selects.

static HourSet operator |(HourSet left, HourSet right)

Parameters

left HourSet

The first set.

right HourSet

The second set.

Returns

HourSet

The union of left and right.

operator ==(HourSet, HourSet)

Determines whether two sets select the same hours.

static bool operator ==(HourSet left, HourSet right)

Parameters

left HourSet

The first set.

right HourSet

The second set.

Returns

bool

true when the sets are equal; otherwise false.

operator ^(HourSet, HourSet)

Returns the hours that exactly one of the sets selects.

static HourSet operator ^(HourSet left, HourSet right)

Parameters

left HourSet

The first set.

right HourSet

The second set.

Returns

HourSet

The symmetric difference of left and right.

operator !=(HourSet, HourSet)

Determines whether two sets select different hours.

static bool operator !=(HourSet left, HourSet right)

Parameters

left HourSet

The first set.

right HourSet

The second set.

Returns

bool

true when the sets differ; otherwise false.

operator ~(HourSet)

Returns the hours from 0 to 23 that the set does not select.

static HourSet operator ~(HourSet value)

Parameters

value HourSet

The set.

Returns

HourSet

The complement of value within 0 to 23.

Applies to

ProductVersions
.NET8, 10