SecondSet Struct
Definition
Represents an immutable set of seconds of the minute, 0 to 59.
public readonly struct SecondSet : ICalendarValueSet<SecondSet, int>, IEquatable<SecondSet>, IEqualityOperators<SecondSet, SecondSet, bool>, IBitwiseOperators<SecondSet, SecondSet, SecondSet>, ISpanParsable<SecondSet>, IParsable<SecondSet>, IUtf8SpanParsable<SecondSet>, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEnumerable<int>, IEnumerable
- Implements
- Inherited Members
- Extension Methods
Examples
var selected = new SecondSet(0, 30);
SecondSet parsed = SecondSet.Parse("0,30");
bool due = selected.Contains(DateTime.Now.Second);
bool same = selected == parsed; // true
Remarks
A SecondSet holds one bit per second, so it never allocates, and testing, adding or removing a
second, or combining two sets with |, &, ^ and ~, is a single bitwise operation.
Contains(int) answers false for any value outside 0 to 59 rather than throwing,
which keeps a membership test against Second to a comparison and a bit test.
A leap second (60) is not a value: DateTime cannot represent one.
The text form lists the seconds in ascending order, separated by commas, each run of two or more consecutive seconds
written as an inclusive range, so "0,30" selects on the minute and the half minute. 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 second without
ranges, or a binary form with one character per second, 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 second
n.
Constructors
SecondSet(params int[]?)
Initializes a new instance of the SecondSet struct that selects the specified seconds.
public SecondSet(params int[]? seconds)
Parameters
Remarks
A second may appear more than once, and the order is immaterial.
Exceptions
- ArgumentOutOfRangeException
Thrown when a value in
secondsis less than 0 or greater than 59.
Properties
Count
Gets the number of seconds the set selects.
public int Count { get; }
Property Value
- int
A number from 0 to 60.
Methods
Contains(int)
Determines whether the set selects the specified second.
public bool Contains(int second)
Parameters
secondintThe second to test.
Returns
Equals(SecondSet)
Determines whether this set selects the same seconds as another.
public bool Equals(SecondSet other)
Parameters
otherSecondSetThe set to compare with.
Returns
Equals(object?)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object? obj)
Parameters
objobjectThe object to compare with the current instance.
Returns
GetEnumerator()
Returns an enumerator that yields the selected seconds in ascending order without allocating.
public SecondSet.Enumerator GetEnumerator()
Returns
- SecondSet.Enumerator
An enumerator over the selected seconds.
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 SecondSet, detecting the form.
public static SecondSet Parse(ReadOnlySpan<byte> utf8Text)
Parameters
utf8TextReadOnlySpan<byte>The UTF-8 text to convert.
Returns
- SecondSet
The set the text describes.
Remarks
The text is decoded and read as Parse(string) reads a string.
Exceptions
- FormatException
Thrown when
utf8Textis not valid UTF-8, or is neither the binary form nor a list of values and ranges from 0 to 59.
Parse(ReadOnlySpan<char>)
Converts a span of characters in one of the forms ToString(string?, IFormatProvider?) writes into a SecondSet, detecting the form.
public static SecondSet Parse(ReadOnlySpan<char> s)
Parameters
sReadOnlySpan<char>The characters to convert.
Returns
- SecondSet
The set the characters describe.
Remarks
The characters are read as Parse(string) reads a string.
Exceptions
- FormatException
Thrown when
sis neither the binary form nor a list of values and ranges from 0 to 59.
Parse(string)
Converts text in one of the forms ToString(string?, IFormatProvider?) writes into a SecondSet, detecting the form.
public static SecondSet Parse(string s)
Parameters
sstringThe text to convert, such as
"0,30".
Returns
- SecondSet
The set the text describes.
Remarks
A text of exactly 60 characters, each 0 or 1, is the binary form, second 0 first. Any other text
is a comma-separated list of seconds 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 60 characters long. ParseExact(string, string) with the "G" format
reads any text as a list.
Exceptions
- ArgumentNullException
Thrown when
sis null.- FormatException
Thrown when
sis neither the binary form nor a list of values and ranges from 0 to 59.
ToString()
Returns the canonical text form of the set: the selected seconds in ascending order, separated by commas, each run of two or more consecutive seconds written as an inclusive range.
public override string ToString()
Returns
- string
The text form, such as
"0-2,30", 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
Returns
- string
The text.
Remarks
The formats are described at ToString(string?, IFormatProvider?).
Exceptions
- FormatException
Thrown when
formatis not a supported format.
ToString(string?, IFormatProvider?)
Returns the set as text in the specified format.
public string ToString(string? format, IFormatProvider? formatProvider)
Parameters
formatstringThe format, or null or empty for the default.
formatProviderIFormatProviderIgnored; the text does not depend on culture.
Returns
- string
The text.
Remarks
The formats, whose letters are read in either case, are:
| Format | Text |
|---|---|
G, the default |
The seconds in ascending order, separated by commas, each run of two or more consecutive seconds as an inclusive
range: "0-2,30".
|
L | Every selected second listed, without ranges: "0,1,2,30". |
B, 0, 1, 01 |
Binary, one character per second from 0 to 59, 0 first, with 1 for a selected second:
"111000000000000000000000000000100000000000000000000000000000".
|
Exceptions
- FormatException
Thrown when
formatis not a supported format.
ToUInt64()
Returns the set's bits, bit n selecting second n.
public ulong ToUInt64()
Returns
- ulong
The bits, with nothing set above bit 59.
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
utf8DestinationSpan<byte>The span to write to.
bytesWrittenintWhen this method returns true, the number of bytes written; otherwise 0.
formatReadOnlySpan<char>The format, or an empty span for the default.
providerIFormatProviderIgnored; the text does not depend on culture.
Returns
- bool
true when the text fits in
utf8Destination; otherwise false, andutf8Destinationis 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
formatis 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
destinationSpan<char>The span to write to.
charsWrittenintWhen this method returns true, the number of characters written; otherwise 0.
formatReadOnlySpan<char>The format, or an empty span for the default.
providerIFormatProviderIgnored; the text does not depend on culture.
Returns
Remarks
The text is the one ToString(string?, IFormatProvider?) returns for the same format.
Exceptions
- FormatException
Thrown when
formatis not a supported format.
TryParse(ReadOnlySpan<byte>, out SecondSet)
Attempts to convert UTF-8 text in one of the forms ToString(string?, IFormatProvider?) writes into a SecondSet, detecting the form.
public static bool TryParse(ReadOnlySpan<byte> utf8Text, out SecondSet result)
Parameters
utf8TextReadOnlySpan<byte>The UTF-8 text to convert.
resultSecondSetWhen this method returns true, the set the text describes; otherwise Empty.
Returns
- bool
true when
utf8Textis valid UTF-8 for the binary form or a list of values and ranges from 0 to 59; otherwise false.
Remarks
The text is decoded and read as Parse(string) reads a string.
TryParse(ReadOnlySpan<char>, out SecondSet)
Attempts to convert a span of characters in one of the forms ToString(string?, IFormatProvider?) writes into a SecondSet, detecting the form.
public static bool TryParse(ReadOnlySpan<char> s, out SecondSet result)
Parameters
sReadOnlySpan<char>The characters to convert.
resultSecondSetWhen this method returns true, the set the characters describe; otherwise Empty.
Returns
Remarks
The characters are read as Parse(string) reads a string.
TryParse(string?, out SecondSet)
Attempts to convert text in one of the forms ToString(string?, IFormatProvider?) writes into a SecondSet, detecting the form.
public static bool TryParse(string? s, out SecondSet result)
Parameters
sstringThe text to convert, such as
"0,30".resultSecondSetWhen this method returns true, the set the text describes; otherwise Empty.
Returns
Remarks
The text is read as Parse(string) reads it.
With(int)
Returns a set that also selects the specified second.
public SecondSet With(int second)
Parameters
secondintThe second to add.
Returns
- SecondSet
A set that selects
secondand every second this set selects.
Exceptions
- ArgumentOutOfRangeException
Thrown when
secondis less than 0 or greater than 59.
Without(int)
Returns a set that no longer selects the specified second.
public SecondSet Without(int second)
Parameters
secondintThe second to remove.
Returns
- SecondSet
A set that selects every second this set selects except
second.
Exceptions
- ArgumentOutOfRangeException
Thrown when
secondis less than 0 or greater than 59.
Explicit Interface Implementations
All
Gets the set that selects every second from 0 to 59.
static SecondSet All { get; }
Returns
Empty
Gets the set that selects no second.
static SecondSet Empty { get; }
Returns
FromUInt64(ulong)
Creates a set from its bits, bit n selecting second n.
static SecondSet FromUInt64(ulong bits)
Parameters
bitsulongThe bits.
Returns
- SecondSet
The set that
bitsdescribe.
Exceptions
- ArgumentOutOfRangeException
Thrown when
bitssets a bit above bit 59, which selects no second.
ParseExact(ReadOnlySpan<char>, ReadOnlySpan<char>)
Converts a span of characters in the specified format into a SecondSet.
static SecondSet ParseExact(ReadOnlySpan<char> s, ReadOnlySpan<char> format)
Parameters
sReadOnlySpan<char>The characters to convert.
formatReadOnlySpan<char>The format of
s, one of those ToString(string?) writes.
Returns
- SecondSet
The set the characters describe.
Remarks
The characters are read as ParseExact(string, string) reads a string.
Exceptions
- FormatException
Thrown when
formatis not a supported format, orsis not text in that format.
ParseExact(string, string)
Converts text in the specified format into a SecondSet.
static SecondSet ParseExact(string s, string format)
Parameters
sstringThe text to convert.
formatstringThe format of
s, one of those ToString(string?) writes.
Returns
- SecondSet
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, 60
characters with no whitespace. The format letters are read in either case.
Exceptions
- ArgumentNullException
Thrown when
sorformatis null.- FormatException
Thrown when
formatis not a supported format, orsis 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<SecondSet>.Parse(string, IFormatProvider)
Parses a string into a value.
static SecondSet IParsable<SecondSet>.Parse(string s, IFormatProvider provider)
Parameters
sstringThe string to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.
Returns
- SecondSet
The result of parsing
s.
Exceptions
- ArgumentNullException
sis null.- FormatException
sis not in the correct format.- OverflowException
sis not representable by SecondSet.
IParsable<SecondSet>.TryParse(string, IFormatProvider, out SecondSet)
Tries to parse a string into a value.
static bool IParsable<SecondSet>.TryParse(string s, IFormatProvider provider, out SecondSet result)
Parameters
sstringThe string to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.resultSecondSetWhen this method returns, contains the result of successfully parsing
sor an undefined value on failure.
Returns
ISpanParsable<SecondSet>.Parse(ReadOnlySpan<char>, IFormatProvider)
Parses a span of characters into a value.
static SecondSet ISpanParsable<SecondSet>.Parse(ReadOnlySpan<char> s, IFormatProvider provider)
Parameters
sReadOnlySpan<char>The span of characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.
Returns
- SecondSet
The result of parsing
s.
Exceptions
- FormatException
sis not in the correct format.- OverflowException
sis not representable by SecondSet.
ISpanParsable<SecondSet>.TryParse(ReadOnlySpan<char>, IFormatProvider, out SecondSet)
Tries to parse a span of characters into a value.
static bool ISpanParsable<SecondSet>.TryParse(ReadOnlySpan<char> s, IFormatProvider provider, out SecondSet result)
Parameters
sReadOnlySpan<char>The span of characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
s.resultSecondSetWhen this method returns, contains the result of successfully parsing
s, or an undefined value on failure.
Returns
IUtf8SpanParsable<SecondSet>.Parse(ReadOnlySpan<byte>, IFormatProvider)
Parses a span of UTF-8 characters into a value.
static SecondSet IUtf8SpanParsable<SecondSet>.Parse(ReadOnlySpan<byte> utf8Text, IFormatProvider provider)
Parameters
utf8TextReadOnlySpan<byte>The span of UTF-8 characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
utf8Text.
Returns
- SecondSet
The result of parsing
utf8Text.
Exceptions
- FormatException
utf8Textis not in the correct format.- OverflowException
utf8Textis not representable by SecondSet.
IUtf8SpanParsable<SecondSet>.TryParse(ReadOnlySpan<byte>, IFormatProvider, out SecondSet)
Tries to parse a span of UTF-8 characters into a value.
static bool IUtf8SpanParsable<SecondSet>.TryParse(ReadOnlySpan<byte> utf8Text, IFormatProvider provider, out SecondSet result)
Parameters
utf8TextReadOnlySpan<byte>The span of UTF-8 characters to parse.
providerIFormatProviderAn object that provides culture-specific formatting information about
utf8Text.resultSecondSetOn return, contains the result of successfully parsing
utf8Textor an undefined value on failure.
Returns
TryParseExact(ReadOnlySpan<char>, ReadOnlySpan<char>, out SecondSet)
Attempts to convert a span of characters in the specified format into a SecondSet.
static bool TryParseExact(ReadOnlySpan<char> s, ReadOnlySpan<char> format, out SecondSet result)
Parameters
sReadOnlySpan<char>The characters to convert.
formatReadOnlySpan<char>The format of
s, one of those ToString(string?) writes.resultSecondSetWhen this method returns true, the set the characters describe; otherwise Empty.
Returns
Remarks
The characters are read as ParseExact(string, string) reads a string.
TryParseExact(string?, string?, out SecondSet)
Attempts to convert text in the specified format into a SecondSet.
static bool TryParseExact(string? s, string? format, out SecondSet result)
Parameters
sstringThe text to convert.
formatstringThe format of
s, one of those ToString(string?) writes.resultSecondSetWhen this method returns true, the set the text describes; otherwise Empty.
Returns
Remarks
The text is read as ParseExact(string, string) reads it.
operator &(SecondSet, SecondSet)
Returns the seconds that both sets select.
static SecondSet operator &(SecondSet left, SecondSet right)
Parameters
Returns
- SecondSet
The intersection of
leftandright.
operator |(SecondSet, SecondSet)
Returns the seconds that either set selects.
static SecondSet operator |(SecondSet left, SecondSet right)
Parameters
Returns
- SecondSet
The union of
leftandright.
operator ==(SecondSet, SecondSet)
Determines whether two sets select the same seconds.
static bool operator ==(SecondSet left, SecondSet right)
Parameters
Returns
operator ^(SecondSet, SecondSet)
Returns the seconds that exactly one of the sets selects.
static SecondSet operator ^(SecondSet left, SecondSet right)
Parameters
Returns
- SecondSet
The symmetric difference of
leftandright.
operator !=(SecondSet, SecondSet)
Determines whether two sets select different seconds.
static bool operator !=(SecondSet left, SecondSet right)
Parameters
Returns
operator ~(SecondSet)
Returns the seconds from 0 to 59 that the set does not select.
static SecondSet operator ~(SecondSet value)
Parameters
valueSecondSetThe set.
Returns
- SecondSet
The complement of
valuewithin 0 to 59.
Applies to
| Product | Versions |
|---|---|
| .NET | 8, 10 |