ByteDev.Strings 11.2.0

dotnet add package ByteDev.Strings --version 11.2.0
NuGet\Install-Package ByteDev.Strings -Version 11.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ByteDev.Strings" Version="11.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Strings --version 11.2.0
#r "nuget: ByteDev.Strings, 11.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ByteDev.Strings as a Cake Addin
#addin nuget:?package=ByteDev.Strings&version=11.2.0

// Install ByteDev.Strings as a Cake Tool
#tool nuget:?package=ByteDev.Strings&version=11.2.0

Build status NuGet Package License: MIT

ByteDev.Strings

Library of extended string related functionality.

Installation

ByteDev.Strings has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.

ByteDev.Strings is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Strings

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

String Extensions

To use any of the extension method reference the ByteDev.Strings namespace.

String extension methods:

  • ContainsAll
  • ContainsAny
  • ContainsOnly
  • ContainsIgnoreCase
  • ContainsWhiteSpace
  • CountOccurrences
  • DetectNewLineType
  • EnsureStartsWith
  • EnsureEndsWith
  • FormatWith
  • GetEndNewLine
  • InsertBeforeUpperCase
  • IsAscii
  • IsDateTime
  • IsDigit
  • IsDigits
  • IsEmpty
  • IsEmailAddress
  • IsFalse
  • IsGuid
  • IsHttpUrl
  • IsIpAddress
  • IsLengthBetween
  • IsLetters
  • IsLowerCase
  • IsNullOrEmpty
  • IsNullOrWhitespace
  • IsNumeric
  • IsPhoneNumber
  • IsUpperCase
  • IsUri
  • IsTime
  • IsTrue
  • IsXml
  • Left
  • LeftWithEllipsis
  • LeftWithInnerEllipsis
  • NormalizeNewLinesToUnix
  • NormalizeNewLinesToWindows
  • Pluralize
  • Remove
  • RemoveBracketedText
  • RemoveEndNewLine
  • RemoveEndsWith
  • RemoveLeadingZeros
  • ReplaceMultiOccurrences
  • RemoveNonDigits
  • RemoveStartsWith
  • RemoveWhiteSpace
  • Repeat
  • ReplaceFirst
  • ReplaceLast
  • ReplaceToken
  • Reverse
  • Right
  • SafeGetChar
  • SafeLength
  • SafeSubstring
  • ToBool
  • ToBoolOrDefault
  • ToByteArray
  • ToSequence
  • ToEnum
  • ToGuid
  • ToInt32
  • ToInt32OrDefault
  • ToInt64
  • ToInt64OrDefault
  • ToKeyValuePair
  • ToLines
  • ToLinesList
  • ToMemoryStream
  • ToUri
  • ToTitleCase
  • Wrap

StringBuilder extension methods:

  • AppendIfEmpty
  • AppendIfNotEmpty
  • AppendLineIfEmpty
  • AppendLineIfNotEmpty
  • AppendLines
  • AppendValues
  • IsEmpty

CaseConverter

CaseConverter can be used to change the case of different strings.

Reference namespace: ByteDev.Strings.Case.

CaseConverter has the following methods:

  • ToCamelCase
  • ToKebabCase
  • ToPascalCase
  • ToSnakeCase
  • ToSnakeUpperCase
string s1 = CaseConverter.ToCamelCase("snake_case", CaseType.SnakeCase);   // "snakeCase"

string s2 = CaseConverter.ToPascalCase("kebab-case", CaseType.KebabCase);  // "KebabCase"

bool isPascalCase = s2.IsPascalCase();   // true

There are also a number of case related string extension methods:

  • IsCamelCase
  • IsKebabCase
  • IsPascalCase
  • IsSnakeCase
  • IsSnakeUpperCase
  • IsCaseType

StringCommands

Various StringCommands are included that encapsulate different string operations.

Reference namespace: ByteDev.Strings.StringCommands.

var c1 = new CaseToLowerCommand().SetValue("John Smith");
var c2 = new CopyPasteCommand(0, 4, 0).SetValue("John Smith");

IStringCommandInvoker invoker = new StringCommandInvoker();

invoker.SetCommands(c1, c2);
invoker.Invoke();

// c1.Result == "john smith" 
// c2.Result == "JohnJohn Smith"

Commands can also be chained together using the StringChainedCommand:

// Note: we don't have to call SetValue on each command just on StringChainedCommand
// as this will provide the initial value.

var commands = new List<StringCommand>
{
    new CaseToLowerCommand(),
    new InsertCommand(100, " lives in England."),
    new CutPasteCommand(5, 5, 0)
};

var c1 = new StringChainedCommand(commands).SetValue("John Smith");

IStringCommandInvoker invoker = new StringCommandInvoker();

invoker.SetCommands(c1);
invoker.Invoke();

// command.Result == "smithjohn  lives in England."

ToStringBuilder

The assembly also contains the type ToStringBuilder to help return string representations of an object when overriding it's ToString method.

Reference namespace: ByteDev.Strings.

public class MyClass
{
    public string Name => "John";

    public string Age => null;

    public IEnumerable<string> Address => new List<string>
    {
        "123 Highstreet",
        "London",
        "UK"
    };

    public override string ToString()
    {
        return new ToStringBuilder()
            .WithNullValue("<null>")
            .WithStringQuoteChar('\'')
            .With(nameof(Name), Name)
            .With(nameof(Age), Age)
            .With(nameof(Address), Address)
            .Build();
    }
}

// ...
string s = new MyClass().ToString();

// s == "Name: 'John', Age: <null>, Address: { '123 Highstreet', 'London', 'UK' }"

Masker

Use the Masker type to help mask different types of strings.

Reference namespace: ByteDev.Strings.Masking.

// Initialize Masker type

var options = new MaskerOptions
{
    MaskChar = '#',
    MaskSpace = true
};

var masker = new Masker(options);
// Mask a payment card number

string card = masker.PaymentCard("4111111111111111");

// card == "############1111"
// Mask an email address

string email = masker.EmailAddress("john.smith@gmail.co.uk");

// email == "j#########@#####.co.uk"
// Mask a custom string

string custom = masker.Custom("12345", 1, 2);

// custom == "1##45"
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on ByteDev.Strings:

Package Downloads
ByteDev.Io

Set of IO related .NET utility classes.

ByteDev.ResourceIdentifier

.NET Standard library of resource identifier (URI) related functionality.

ByteDev.Validation.Fluent

Extensions and functionality to use with the Fluent Validation library.

ByteDev.Nuget.Nuspec

.NET Standard library for reading nuget nuspec manifest files.

ByteDev.Subtitles.SubRip

.NET Standard library to help when using SubRip subtitles.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
11.2.0 187 3/20/2024
11.1.0 2,154 12/13/2022
11.0.0 568 6/20/2022
10.0.0 707 6/2/2022
9.5.0 2,500 11/30/2021
9.4.0 903 8/16/2021
9.3.0 4,595 7/14/2021
9.2.0 509 5/27/2021
9.1.0 2,736 3/29/2021
9.0.0 348 3/15/2021
8.3.0 474 3/10/2021
8.2.0 335 1/28/2021
8.1.0 523 12/31/2020
8.0.0 699 11/10/2020
7.0.0 412 11/5/2020
6.0.0 618 9/30/2020
5.0.0 394 9/28/2020
4.1.0 727 7/17/2020
4.0.0 429 7/1/2020
3.0.0 487 6/16/2020
2.1.0 517 5/29/2020
2.0.1 479 5/29/2020
2.0.0 437 5/28/2020
1.0.0 503 4/30/2020