Skip to content

Commit 68d321b

Browse files
GuiorgyGuiorgy
committed
renamed CountExceedingBehaviour options
also reworded their summaries
1 parent ab472d2 commit 68d321b

9 files changed

+32
-32
lines changed

‎src/CountExceedingBehaviour.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44
namespace SpanExtensions
55
{
66
/// <summary>
7-
/// Defines the behaviour of a split operation when there are more split instances than there may be.
7+
/// Defines the behaviour of a split operation when there are more split instances than desired.
88
/// </summary>
99
public enum CountExceedingBehaviour
1010
{
1111
/// <summary>
12-
/// The last element returned will be all the remaining elements appended as one.
12+
/// The last split returned will include all the remaining elements.
1313
/// </summary>
14-
AppendLastElements,
14+
IncludeRemainingElements,
1515
/// <summary>
16-
/// Every split instance more than permitted will not be returned.
16+
/// Splits after the desired split count will be dropped..
1717
/// </summary>
18-
CutLastElements
18+
DropRemainingElements
1919
}
2020

2121
/// <summary>

‎src/Enumerators/Split/SpanSplitStringSplitOptionsWithCountEnumerator.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public ref struct SpanSplitStringSplitOptionsWithCountEnumerator
2929
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
3030
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
3131
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
32-
public SpanSplitStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, char delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
32+
public SpanSplitStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, char delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3333
{
3434
Span = source;
3535
Delimiter = delimiter;
@@ -86,7 +86,7 @@ public bool MoveNext()
8686
continue;
8787
}
8888

89-
if(CountExceedingBehaviour == CountExceedingBehaviour.CutLastElements)
89+
if(CountExceedingBehaviour == CountExceedingBehaviour.DropRemainingElements)
9090
{
9191
Span = beforeDelimiter;
9292
}
@@ -98,7 +98,7 @@ public bool MoveNext()
9898
}
9999
else
100100
{
101-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
101+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
102102
}
103103

104104
if(TrimEntries)

‎src/Enumerators/Split/SpanSplitWithCountEnumerator.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace SpanExtensions.Enumerators
2727
/// <param name="delimiter">An instance of <typeparamref name="T"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
2828
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
2929
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
30-
public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
30+
public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3131
{
3232
Span = source;
3333
Delimiter = delimiter;
@@ -62,7 +62,7 @@ public bool MoveNext()
6262
{
6363
EnumerationDone = true;
6464

65-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
65+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
6666

6767
return true;
6868
}

‎src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsWithCountEnumerator.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public ref struct SpanSplitAnyStringSplitOptionsWithCountEnumerator
2929
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
3030
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
3131
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
32-
public SpanSplitAnyStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
32+
public SpanSplitAnyStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3333
{
3434
Span = source;
3535
Delimiters = delimiters;
@@ -86,7 +86,7 @@ public bool MoveNext()
8686
continue;
8787
}
8888

89-
if(CountExceedingBehaviour == CountExceedingBehaviour.CutLastElements)
89+
if(CountExceedingBehaviour == CountExceedingBehaviour.DropRemainingElements)
9090
{
9191
Span = beforeDelimiter;
9292
}
@@ -98,7 +98,7 @@ public bool MoveNext()
9898
}
9999
else
100100
{
101-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
101+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
102102
}
103103

104104
if(TrimEntries)

‎src/Enumerators/SplitAny/SpanSplitAnyWithCountEnumerator.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace SpanExtensions.Enumerators
2727
/// <param name="delimiters">A <see cref="ReadOnlySpan{T}"/> with the instances of <typeparamref name="T"/> that delimit the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
2828
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
2929
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
30-
public SpanSplitAnyWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
30+
public SpanSplitAnyWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3131
{
3232
Span = source;
3333
Delimiters = delimiters;
@@ -62,7 +62,7 @@ public bool MoveNext()
6262
{
6363
EnumerationDone = true;
6464

65-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
65+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
6666

6767
return true;
6868
}

‎src/Enumerators/SplitSequence/SpanSplitSequenceStringSplitOptionsWithCountEnumerator.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public ref struct SpanSplitSequenceStringSplitOptionsWithCountEnumerator
2929
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
3030
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
3131
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
32-
public SpanSplitSequenceStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
32+
public SpanSplitSequenceStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3333
{
3434
Span = source;
3535
Delimiter = delimiter;
@@ -87,7 +87,7 @@ public bool MoveNext()
8787
continue;
8888
}
8989

90-
if(CountExceedingBehaviour == CountExceedingBehaviour.CutLastElements)
90+
if(CountExceedingBehaviour == CountExceedingBehaviour.DropRemainingElements)
9191
{
9292
Span = beforeDelimiter;
9393
}
@@ -99,7 +99,7 @@ public bool MoveNext()
9999
}
100100
else
101101
{
102-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
102+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
103103
}
104104

105105
if(TrimEntries)

‎src/Enumerators/SplitSequence/SpanSplitSequenceWithCountEnumerator.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace SpanExtensions.Enumerators
2727
/// <param name="delimiter">An instance of <see cref="ReadOnlySpan{T}"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
2828
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
2929
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
30-
public SpanSplitSequenceWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
30+
public SpanSplitSequenceWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
3131
{
3232
Span = source;
3333
Delimiter = delimiter;
@@ -63,7 +63,7 @@ public bool MoveNext()
6363
{
6464
EnumerationDone = true;
6565

66-
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.AppendLastElements ? Span : Span[..delimiterIndex];
66+
Current = delimiterIndex == -1 || CountExceedingBehaviour == CountExceedingBehaviour.IncludeRemainingElements ? Span : Span[..delimiterIndex];
6767

6868
return true;
6969
}

‎src/Extensions/ReadOnlySpan/ReadOnlySpanExtensions.Split.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public static SpanSplitEnumerator<T> Split<T>(this ReadOnlySpan<T> source, T del
3030
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
3131
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
3232
/// <returns>An instance of the ref struct <see cref="SpanSplitWithCountEnumerator{T}"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
33-
public static SpanSplitWithCountEnumerator<T> Split<T>(this ReadOnlySpan<T> source, T delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements) where T : IEquatable<T>
33+
public static SpanSplitWithCountEnumerator<T> Split<T>(this ReadOnlySpan<T> source, T delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements) where T : IEquatable<T>
3434
{
3535
return new SpanSplitWithCountEnumerator<T>(source, delimiter, count, countExceedingBehaviour);
3636
}
@@ -56,7 +56,7 @@ public static SpanSplitStringSplitOptionsEnumerator Split(this ReadOnlySpan<char
5656
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
5757
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
5858
/// <returns>An instance of the ref struct <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
59-
public static SpanSplitStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> source, char delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
59+
public static SpanSplitStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> source, char delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
6060
{
6161
return new SpanSplitStringSplitOptionsWithCountEnumerator(source, delimiter, count, options, countExceedingBehaviour);
6262
}
@@ -82,7 +82,7 @@ public static SpanSplitAnyEnumerator<T> SplitAny<T>(this ReadOnlySpan<T> source,
8282
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
8383
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
8484
/// <returns>An instance of the ref struct <see cref="SpanSplitAnyWithCountEnumerator{T}"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
85-
public static SpanSplitAnyWithCountEnumerator<T> SplitAny<T>(this ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements) where T : IEquatable<T>
85+
public static SpanSplitAnyWithCountEnumerator<T> SplitAny<T>(this ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements) where T : IEquatable<T>
8686
{
8787
return new SpanSplitAnyWithCountEnumerator<T>(source, delimiters, count, countExceedingBehaviour);
8888
}
@@ -108,7 +108,7 @@ public static SpanSplitAnyStringSplitOptionsEnumerator SplitAny(this ReadOnlySpa
108108
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
109109
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
110110
/// <returns>An instance of the ref struct <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
111-
public static SpanSplitAnyStringSplitOptionsWithCountEnumerator SplitAny(this ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
111+
public static SpanSplitAnyStringSplitOptionsWithCountEnumerator SplitAny(this ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
112112
{
113113
return new SpanSplitAnyStringSplitOptionsWithCountEnumerator(source, delimiters, count, options, countExceedingBehaviour);
114114
}
@@ -134,7 +134,7 @@ public static SpanSplitSequenceEnumerator<T> Split<T>(this ReadOnlySpan<T> sourc
134134
/// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
135135
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
136136
/// <returns>An instance of the ref struct , which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
137-
public static SpanSplitSequenceWithCountEnumerator<T> Split<T>(this ReadOnlySpan<T> source, ReadOnlySpan<T> delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements) where T : IEquatable<T>
137+
public static SpanSplitSequenceWithCountEnumerator<T> Split<T>(this ReadOnlySpan<T> source, ReadOnlySpan<T> delimiter, int count, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements) where T : IEquatable<T>
138138
{
139139
return new SpanSplitSequenceWithCountEnumerator<T>(source, delimiter, count, countExceedingBehaviour);
140140
}
@@ -160,7 +160,7 @@ public static SpanSplitSequenceStringSplitOptionsEnumerator Split(this ReadOnlyS
160160
/// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
161161
/// <param name="countExceedingBehaviour">The handling of the instances more than count.</param>
162162
/// <returns>An instance of the ref struct <see cref="SpanSplitSequenceStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
163-
public static SpanSplitSequenceStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.AppendLastElements)
163+
public static SpanSplitSequenceStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options, CountExceedingBehaviour countExceedingBehaviour = CountExceedingBehaviour.IncludeRemainingElements)
164164
{
165165
return new SpanSplitSequenceStringSplitOptionsWithCountEnumerator(source, delimiter, count, options, countExceedingBehaviour);
166166
}

0 commit comments

Comments
 (0)