Skip to content

Latest commit

 

History

History
154 lines (90 loc) · 3.68 KB

README.md

File metadata and controls

154 lines (90 loc) · 3.68 KB

Open.Text

A set of useful extensions for working with strings, string-segments, spans, enums, and value formatting.

NuGet

Features

  • Avoids allocation wherever possible.
  • v3.x is a major overhaul with much improved methods and expanded tests and coverage.
  • v4.x favored use of Microsoft.Extensions.Primitives.StringSegments for string manipulation.

Regex Extensions

ReadOnlySpan<char> Capture.AsSpan()
Enumerable<StringSegment> Regex.AsSegments(string input)
string GroupCollection.GetValue(string groupName)
ReadOnlySpan<char> GroupCollection.GetValueSpan(string groupName)
IEnumerable<StringSegment> string.Split(Regex pattern)

String vs Span Equality

Optimized .Equals(...) extension methods for comparing spans and strings.

String & Span Splitting

SplitToEnumerable

Returns each string segment of the split through an enumerable instead of all at once in an array.

SplitAsMemory

Produces an enumerable where each segment is yielded as a ReadOnlyMemory<char>.

SplitAsSegment

Produces an enumerable where each segment is yielded as a StringSegment.

Trimming

TrimStartPattern & TrimEndPattern

Similar to their character trimming counterparts, these methods can trim sequences of characters or regular expression patterns.

StringBuilder Extensions

Extensions for:

  • adding segments with separators.
  • adding spans without creating a string first.
  • converting enumerables to a StringBuilder.

StringSegment Extensions

Extensions for:

  • .Trim(char) and .Trim(ReadOnlySpan<char>).
  • finding and pivoting from sequences without allocation.

StringComparable & SpanComparable Extensions

if(myString.AsCaseInsensitive()=="HELLO!") { }

instead of

if(myString.Equals("HELLO!", StringComparison.OrdinalIgnoreCase)) { }

EnumValue<TEnum> & EnumValueIgnoreCase<TEnum>

Implicit conversion makes it easy. Optimized methods make it fast.

Consider the following:

enum Greek { Alpha, Beta, Gamma }

void DoSomethingWithGreek(Greek value) { }

DoSomethingWithGreek(Greek.Alpha);

It's nice that Greek is an enum because it won't be null, and it has to be one of the values. But what if you want to write a single function that will take an Greek or a string? This gets problematic as the string value has to be parsed and you'll likely need an overload.

EnumValue<TEnum> solves this problem:

enum Greek { Alpha, Beta, Gamma }

void DoSomethingWithGreek(EnumValue<Greek> value) { }

// Both work fine.
DoSomethingWithGreek("Alpha");
DoSomethingWithGreek(Greek.Alpha);

// Throws an ArgumentException:
DoSomethingWithGreek("Theta");

The implicit conversion between a string and EnumValue<TEnum> make this possible.

If you need to allow for case-insensitive comparison then simply use EnumValueCaseIgnored<TEnum> instead.

The performance is outstanding as it uses the length of the names to build a tree in order to parse values and uses an expression tree instead of calling .ToString() on the value.

And more ...

string.Supplant(...)

An alternative to String.Format that takes an array of values.

string.ReplaceWhiteSpace(...)

A shortcut for replacing whitespace with a Regex.

string.ToMetricString(...)

Returns an abbreviated metric representation of a number.

ToByteString(...)

Returns an abbreviated metric representation of a quantity of bytes.

ToPercentString(...)

Shortcut for formating to a percent.

ToNullIfWhiteSpace()

Allows for simple null operators if a string is empty or whitespace.