StringUtil

Description

static class Tinman.Core.StringUtil

Helper class for dealing with strings.

Public / Constants

DelegateCompare

[ShutdownSurvive]
public static readonly attribute DelegateCompare → (CompareDelegate<string>)

The delegate for Compare.

DelegateEquals

[ShutdownSurvive]
public static readonly attribute DelegateEquals → (EqualsDelegate<string>)

The delegate for Equals.

DelegateHash

[ShutdownSurvive]
public static readonly attribute DelegateHash → (HashCodeDelegate<string>)

The delegate for Hash.

LoremIpsum

public constant LoremIpsum → ("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. ":string)

Some boilerplate text.

The text contains no line-breaks and a single whitespace at the end:

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At
vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,
no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit
amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut
labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam
et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata
sanctus est Lorem ipsum dolor sit amet.

LoremIpsumBlock

public constant LoremIpsumBlock → ("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod\r\ntempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At\r\nvero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,\r\nno sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit\r\namet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut\r\nlabore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam\r\net justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata\r\nsanctus est Lorem ipsum dolor sit amet. ":string)

Some boilerplate text.

The text contains CRLF line-breaks (wrapping at 80 columns) and a single whitespace at the end:

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At
vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,
no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit
amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut
labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam
et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata
sanctus est Lorem ipsum dolor sit amet.

Public / Methods

Base64Decode

[Pure]
public static method Base64Decode → (1)

base64 ⁱⁿ : string: The base-64 string to decode.
returns → int8 [ ]: The decoded byte array or null if base64 ⁱⁿ is null or not valid base-64.

Decodes the given base-64 string (RFC 4648).

BinaryDecode

[Pure]
public static method BinaryDecode → (1)

value ⁱⁿ : int8 [ ]: The compressed byte array.
returns → string: The decoded string or null if value ⁱⁿ is null.

Decodes a string from the given compressed byte array.

IOException: If the binary format of value ⁱⁿ is invalid.

See also: StringUtil.BinaryEncode

BinaryEncode

[Pure]
public static method BinaryEncode → (1)

value ⁱⁿ : string: The string value.
returns → int8 [ ]: The compressed byte array or null if value ⁱⁿ is null.

Encodes the given string as a compressed byte array.

See also: StringUtil.BinaryDecode

CharAt

[Pure]
public static method CharAt → (3)

str ⁱⁿ : string: The string.
index ⁱⁿ : int32: The index.
replacement ^opt : char = '\0': The value to return in case index ⁱⁿ is out of the valid index range or str ⁱⁿ is null.
returns → char: The index ⁱⁿ-th character or replacement ^opt (see above).

Returns the index ⁱⁿ-th character in the given string.

Coalesce

[Pure]
public static method Coalesce → (3)

value ⁱⁿ : string: The input string value.
defaultValue ^opt : string = null: The replacement value.
isEmpty ^opt : bool = true: true to replace value if empty (see IsEmptyOrWhitespace), false to replace value if null.
returns → string: The resulting value.

Replaces the given value ⁱⁿ if it is null and/or empty.

Compare

[Pure]
public static method Compare → (2)

a ⁱⁿ : string: First string value.
b ⁱⁿ : string: Second string value.
returns → int32: if a ⁱⁿ is less than b ⁱⁿ.
[=0] if a ⁱⁿ is equal to b ⁱⁿ.
[>0] if a ⁱⁿ is greater than b ⁱⁿ.

Compares the given strings.

null string values appear first.
Sort order is ascending, according to ordinal UTF-16 character value.
Of two strings having the same prefix, the shorter one appears first.

CompareChar

[Pure]
public static method CompareChar → (3)

first ⁱⁿ : char: The first character.
second ⁱⁿ : char: The second character.
caseSensitive ^opt : bool = true: Do case-sensitive comparison?
returns → int32: <0 if first ⁱⁿ is less than second ⁱⁿ.
0 if first ⁱⁿ is equal to second ⁱⁿ.
>0 if first ⁱⁿ is greater than second ⁱⁿ.

Compares the given characters.

ComparePart

[Pure]
public static method ComparePart → (7)

first ⁱⁿ : string: The first string.
firstIdx ⁱⁿ : int32: Index of substring in first ⁱⁿ.
firstLength ⁱⁿ : int32: Length of substring in first ⁱⁿ.
second ⁱⁿ : string: The second string.
secondIdx ⁱⁿ : int32: Index of substring in second ⁱⁿ.
secondLength ⁱⁿ : int32: Length of substring in second ⁱⁿ.
caseSensitive ^opt : bool = true: Do case-sensitive comparison?
returns → int32: <0 if first ⁱⁿ is less than second ⁱⁿ.
0 if first ⁱⁿ is equal to second ⁱⁿ.
>0 if first ⁱⁿ is greater than second ⁱⁿ.

Compares two substrings.

This method considers a null string to be less than a non-null one. Shorter strings are also considered less than longer ones.

Concatenate

[Pure]
public static method Concatenate → (4)

tokens ⁱⁿ : IEnumerable<string>: [not-null]
The string tokens to concatenate.
delimiter ^opt : string = null: Optional delimiter token to insert between tokens.
prefix ^opt : string = null: Optional prefix token.
suffix ^opt : string = null: Optional suffix token.
returns → string: The resulting string.

Concatenates the given string tokens using the specified delimiter, prefix and suffix.

ContainsAt

[Pure]
public static method ContainsAt → (3)

value ⁱⁿ : string: [not-null]
The string to check.
offset ⁱⁿ : int32: [0..value.Length]
Offset into value ⁱⁿ.
part ⁱⁿ : string: [not-null]
The string part to find in value ⁱⁿ.
returns → bool: true if part ⁱⁿ is contained in value ⁱⁿ at offset ⁱⁿ,
false if not.

Checks if the given string value ⁱⁿ contains the given part ⁱⁿ at the specified offset ⁱⁿ.

DefaultIfEmpty

[Pure]
public static method DefaultIfEmpty → (2)

value ⁱⁿ : string: The string value.
defaultValue ⁱⁿ : string: The default value.
returns → string: The resulting value.

Returns the given default value if value ⁱⁿ is null or has a length of 0.

DefaultIfEmptyOrWhitespace

[Pure]
public static method DefaultIfEmptyOrWhitespace → (2)

value ⁱⁿ : string: The string value.
defaultValue ^opt : string = "": The default value.
returns → string: The resulting value.

Returns the given default value if value ⁱⁿ is null, has a length of 0 or contains only whitespace characters.

DefaultIfNull

[Pure]
public static method DefaultIfNull → (2)

value ⁱⁿ : string: The string value.
defaultValue ^opt : string = "": The default value.
returns → string: The resulting value.

Returns the given default value if value ⁱⁿ is null.

Equals

[Pure]
public static method Equals → (2)

a ⁱⁿ : string: First string value.
b ⁱⁿ : string: Second string value.
returns → bool: true if both string values are equal, false if not.

Checks if the given string values are equal (case-sensitive).

This method is intended for being used as an equality delegate.

EqualsNoCase

[Pure]
public static method EqualsNoCase → (2)

a ⁱⁿ : string: First string value.
b ⁱⁿ : string: Second string value.
returns → bool: true if both string values are equal, false if not.

Checks if the given string values are equal (case-insensitive).

This method is intended for being used as an equality delegate.

See also: StringUtil.ToLower¹

Hash

[Pure]
public static method Hash → (1)

s ⁱⁿ : string: The string value.
returns → int32: The hash code.

Computes a hash code for the given string, using HashUtil.Str (case-sensitive).

This method is intended for being used as a hash code delegate.

HashNoCase

[Pure]
public static method HashNoCase → (1)

s ⁱⁿ : string: The string value.
returns → int32: The hash code.

Computes a hash code for the given string, using HashUtil.Str (case-insensitive).

This method is intended for being used as a hash code delegate.

See also: StringUtil.ToLower¹

IsEmpty

[Pure]
public static method IsEmpty → (1)

value ⁱⁿ : string: The string.
returns → bool: true if value ⁱⁿ is empty, false if not.

Checks if the given string is empty.

A string is considered empty if it is null or has a length or 0.

IsEmptyOrWhitespace

[Pure]
public static method IsEmptyOrWhitespace → (1)

value ⁱⁿ : string: The string.
returns → bool: true if value ⁱⁿ is empty or whitespace., false if not.

Checks if the given string is empty or whitespace.

A string is considered empty or whitespace. if it is null, has a length or 0 or contains only whitespace characters.

MinimumValidIndex

[Pure]
public static method MinimumValidIndex → (2)

a ⁱⁿ : int32: First index value.
b ⁱⁿ : int32: Second index value.
returns → int32: The minimum valid index.

Returns the minimum valid (i.e. non-negative) string index value.

NumberFormat

[Pure]
public static method NumberFormat → (3)

value ⁱⁿ : float64: The number to format (must neither be infinity nor not-a-number).
single ⁱⁿ : bool: Format as single precision (true) or double precision (false)?
parsable ⁱⁿ : bool: Format using roundtrip precision (i.e. the formatted value can be parsed back without loss of information)?
returns → string: The formatted number string.

Formats the given floating-point number as a decimal string.

See also: StringUtil.NumberParse

NumberParse

[Pure]
public static method NumberParse → (1)

value ⁱⁿ : string: The value to parse.
returns → float64: The parsed value or Maths.NanD if value ⁱⁿ is not a valid number string.

Parses the given regular floating point number (as defined by the float rule described by Parse.ParseGrammar, excluding NaN or Inf).

Parse.Number

See also: StringUtil.NumberFormat

Replace

[Pure]
public static method Replace → (4)

text ⁱⁿ : string: [not-null]
The input text.
find ⁱⁿ : string: [not-null]
The text to find and replace.
replace ^opt : string = "": [not-null]
The replacement text.
offset ^opt : int32 = 0: [0..text.Length]
Offset into text ⁱⁿ.
returns → string: The resulting string.

Replaces all occurrences of find ⁱⁿ in text ⁱⁿ with replace ^opt.

ToCamelCase

[Pure]
public static method ToCamelCase → (1)

name ⁱⁿ : string: [not-null]
The input name.
returns → string: The camel case name.

Generates a camel case name from the given input:
'SOME_NAME_WITH_UNDERSCORES' => 'SomeNameWithUnderscores'

ToChars

public static method ToChars → (3)

value ⁱⁿ : string: [not-null]
The input string.
offset ^opt : int32 = 0: [0..value.Length]
Offset into value ⁱⁿ.
length ^opt : int32 = -1: [-1..value.Length-offset]
Number of characters to copy or -1 to copy all characters in value ⁱⁿ from offset ^opt.
returns → char [ ]: The output character sequence.

Returns a character sequence for the given string.

See also: StringUtil.ToString

ToHexB

[Pure]
public static method ToHexB → (1)

value ⁱⁿ : int8: The value.
returns → string: The hexadecimal number string.

Returns a hexadecimal number string for the given 8-bit integer value.

ToHexI

[Pure]
public static method ToHexI → (1)

value ⁱⁿ : int32: The value.
returns → string: The hexadecimal number string, without 0x prefix.

Returns a hexadecimal number string for the given 32-bit integer value.

ToHexL

[Pure]
public static method ToHexL → (1)

value ⁱⁿ : int64: The value.
returns → string: The hexadecimal number string, without 0x prefix.

Returns a hexadecimal number string for the given 64-bit integer value.

ToHexS

[Pure]
public static method ToHexS → (1)

value ⁱⁿ : int16: The value.
returns → string: The hexadecimal number string, without 0x prefix.

Returns a hexadecimal number string for the given 16-bit integer value.

ToLines

[Pure]
public static method ToLines → (1)

text ⁱⁿ : string: [not-null]
The text to split.
returns → string [ ]: The separate text lines. Empty lines are preseverd.

Splits the given text into separate lines.

See also: Text.ToArray

ToLower

_2 overloads

[Pure]
public static method ToLower¹ → (1)

c ⁱⁿ : char: The character.
returns → char: The lowercase character.

Returns the culture-invariant lowercase of the given character.

[Pure]
public static method ToLower² → (1)

s ⁱⁿ : string: The string.
returns → string: The lowercase string or null iff s ⁱⁿ is null.

Returns the culture-invariant lowercase of the given string.

ToLowerFirst

[Pure]
public static method ToLowerFirst → (1)

str ⁱⁿ : string: The string.
returns → string: The resulting string.

Converts the first character of the given string to lower-case.

ToString

[Pure]
public static method ToString → (3)

array ⁱⁿ : char [ ]: [not-null]
The input character array.
offset ^opt : int32 = 0: [0..array.Length]
Offset into array ⁱⁿ.
length ^opt : int32 = -1: [-1..array.Length-offset]
Number of characters to copy or -1 to copy all characters in array ⁱⁿ from offset ^opt.
returns → string: The output string.

Returns a string from the given character sequence.

See also: StringUtil.ToChars

ToUpper

_2 overloads

[Pure]
public static method ToUpper¹ → (1)

c ⁱⁿ : char: The character.
returns → char: The uppercase character.

Returns the culture-invariant uppercase of the given character.

[Pure]
public static method ToUpper² → (1)

s ⁱⁿ : string: The string.
returns → string: The uppercase string or null iff s ⁱⁿ is null.

Returns the culture-invariant uppercase of the given string.

ToUpperFirst

[Pure]
public static method ToUpperFirst → (1)

str ⁱⁿ : string: The string.
returns → string: The resulting string.

Converts the first character of the given string to upper-case.

Trim

[Pure]
public static method Trim → (2)

value ⁱⁿ : string: [not-null]
The string value to trim.
how ^opt : int32 = 0: < 0 : trim only leading whitespace,
= 0 : trim leading and trailing whitespace,
> 0 : trim trailing whitespace
returns → RangeI: The trimmed character range in value ⁱⁿ.

Trims leading and/or trailing whitespace characters.

See also: FormattingUtil.IsWhitespace

UniqueTag

[Pure]
public static method UniqueTag → ()

returns → string: The unique string tag.

Returns a string tag (4 letters or digits) that is pseudo-unique (the tag sequence will repeat after 1679616 elements) in the calling process.

StringUtil

Description

Public / Constants

Delegate​Compare

Delegate​Equals

Delegate​Hash

Lorem​Ipsum

Lorem​Ipsum​Block

Public / Methods

Base64​Decode

Binary​Decode

Binary​Encode

Char​At

Coalesce

Compare

Compare​Char

Compare​Part

Concatenate

Contains​At

Default​If​Empty

Default​If​Empty​Or​Whitespace

Default​If​Null

Equals

Equals​No​Case

Hash

Hash​No​Case

Is​Empty

Is​Empty​Or​Whitespace

Minimum​Valid​Index

Number​Format

Number​Parse