FormattingUtil

Description

static class Tinman.Core.Formatting.FormattingUtil

Helper class for dealing with Unicode characters.

Public / Methods

FormatBytes

[Pure]
public static method FormatBytes → (1)

bytes ⁱⁿ : int64: The binary size, in bytes.
returns → string: The formatted size string.

Formats the given binary size using up to four decimal digits.

The following units are used:

'b': byte
'kb': kilo-byte (2^10)
'mb': mega-byte (2^20)
'gb': giga-byte (2^30)
'tb': tera-byte (2^40)
'pb': peta-byte (2^50)
'eb': exa-byte (2^60)

FormatDegrees

[Pure]
public static method FormatDegrees → (1)

value ⁱⁿ : float64: The angle value, in degrees.
returns → string: The formatted angle value.

Formats an angle value: '123°'

FormatErrorCode

[Pure]
public static method FormatErrorCode → (2)

errorCode ⁱⁿ : int64: The error code.
mask ^opt : bool = false: true : errorCode ⁱⁿ is a 32-bit unsigned integer value,
false : errorCode ⁱⁿ is some other integer value.
returns → string: The formatted error code.

Formats an error code.

Negative error codes are formatted as decimal numbers (for example: "-123"). Zero is formatted as "0". All other error codes are formatted as hexadecimal numbers with 2, 4 or 8 digits.

FormatMetric

[Pure]
public static method FormatMetric → (1)

length ⁱⁿ : float64: The length, in metres.
returns → string: The formatted length string.

Formats the given metric length in a readable way (e.g. '10.5 cm').

The metric unit is chosen (km, m, cm or mm) so that the resulting string has a minimum number of decimal digits.

FormatPercent

[Pure]
public static method FormatPercent → (1)

value ⁱⁿ : float64: The decimal value.
returns → string: The formatted angle in degrees.

Formats a percent value: '100%'

FormatRadians

[Pure]
public static method FormatRadians → (1)

value ⁱⁿ : float64: The angle value, in radians.
returns → string: The formatted angle in degrees.

Formats an angle value: '123°'

FormatReadable

[Pure]
public static method FormatReadable → (1)

value ⁱⁿ : float64: Some value.
returns → float64: The nicely readable value.

Returns the largest positive nicely readable value that is less than or equal to the given value.

A nicely readable value can be expressed with 10^N*M where N is an integer and M is one of: 1, 2, 5.
For example:
0.1, 0.2, 0.5, 1, 2, 5, 10

FormatTimeSpan

_2 overloads

[Pure]
public static method FormatTimeSpan¹ → (2)

time ⁱⁿ : float64: [>=0]
The time span, in milliseconds.
format ^opt : int32 = 0: [-1..5]
The time index format:
-1: 1w 1d 1h 1m 1s 1ms (leading zero parts are omitted)
0: 1w 1d 1h 1m 1s (leading zero parts are omitted)
1: HH:MM:SS,FFF
2: HH:MM:SS,FF
3: HH:MM:SS,F
4: HH:MM:SS
5: HH:MM
returns → string: The formatted time index string.

Formats the given time span.

[Pure]
public static method FormatTimeSpan² → (2)

time ⁱⁿ : int64: [>=0]
The time span, in milliseconds.
format ^opt : int32 = 0: [-1..5]
The time index format:
-1: 1w 1d 1h 1m 1s 1ms (leading zero parts are omitted)
0: 1w 1d 1h 1m 1s (leading zero parts are omitted)
1: HH:MM:SS,FFF
2: HH:MM:SS,FF
3: HH:MM:SS,F
4: HH:MM:SS
5: HH:MM
returns → string: The formatted time index string.

Formats the given time span.

GetCategory

[Pure]
public static method GetCategory → (1)

c ⁱⁿ : int32: The Unicode character.
returns → CharacterCategory: The Unicode category.

Returns the Unicode category of the given character.

GetCharacters

_2 overloads

public static method GetCharacters¹ → (3)

from ⁱⁿ : int32: Start of code point range (inclusive).
to ⁱⁿ : int32: End of code point range (inclusive).
bag ^opt : IBag<int32> = null: Optional output bag.
returns → IBag<int32>: The code points of the characters.

Returns all characters in the given code point range.

public static method GetCharacters² → (2)

categories ⁱⁿ : CharacterCategory: The character categories.
bag ^opt : IBag<int32> = null: Optional output bag.
returns → IBag<int32>: The code points of the characters.

Returns all characters that belong to the given categories.

IsCategory

[Pure]
public static method IsCategory → (2)

c ⁱⁿ : int32: The Unicode character.
categories ⁱⁿ : CharacterCategory: The character categories.
returns → bool: true if c ⁱⁿ has at least one category given by categories ⁱⁿ, false if not.

Checks if the given character belongs to any of the given categories.

IsSeparatorOrWhitespaceControl

[Pure]
public static method IsSeparatorOrWhitespaceControl → (1)

c ⁱⁿ : int32: The Unicode character.
returns → bool: true if c ⁱⁿ is a separator or a whitespace control, false if not.

Checks if the given character is a separator or a whitespace control.

This method will return true only in the following cases:

IsCategory returns true for CharacterCategory.Separator.
The given character is one of these CharacterCategory.OtherControl characters:
'\u0009', '\u000A', '\u000B', '\u000C', '\u000D', '\u0085'

The string.Trim method of string trims characters only if IsSeparatorOrWhitespaceControl would return true.

See also: FormattingUtil.IsWhitespace

IsWhitespace

[Pure]
public static method IsWhitespace → (1)

c ⁱⁿ : int32: The Unicode character.
returns → bool: true if c ⁱⁿ is a whitespace, false if not.

Checks if the given character is a whitespace.

Using this method is equivalent to calling IsCategory with the CharacterCategory.Whitespace flag. However, this method is more efficient.

See also: FormattingUtil.IsSeparatorOrWhitespaceControl

Newline

_2 overloads

public static method Newline¹ → (2)

text ⁱⁿ : string: The text to normalize.
lineEnding ^opt : LineEnding = LineEnding.LF: The line ending to use.
returns → string: The normalized text or null if text ⁱⁿ was null.

Replaces all newline tokens in text ⁱⁿ with the specified newline token.

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

lineEnding ^opt : LineEnding = LineEnding.LF: The line ending.
returns → string: The newline token.

Returns the newline token string.

TextToLines

[Pure]
public static method TextToLines → (2)

text ⁱⁿ : string: [not-null]
The text to split.
trim ^opt : bool = false: Trim text lines?
returns → string [ ]: The array of text lines.

Splits the given text into lines.

ToLineEnding

public static method ToLineEnding → (2)

text ⁱⁿ : string: [not-null]
The input text.
lineEnding ^opt : LineEnding = LineEnding.LF: The desired line ending type.
returns → string: The normalized text.

Normalizes all line ending tokens in the given text.

Public / Attributes

NativeLineEnding

public static attribute NativeLineEnding → (get)

value : LineEnding: [not-null]
The newline token.

Returns the newline token of the underlying system.

FormattingUtil

Description

Public / Methods

Format​Bytes

Format​Degrees

Format​Error​Code

Format​Metric

Format​Percent

Format​Radians

Format​Readable

Format​Time​Span

Get​Category

Get​Characters

Is​Category

Is​Separator​Or​Whitespace​Control

Is​Whitespace

Newline

Text​To​Lines

To​Line​Ending

Public / Attributes

Native​Line​Ending

FormatBytes

FormatDegrees

FormatErrorCode

FormatMetric

FormatPercent

FormatRadians

FormatReadable

FormatTimeSpan

GetCategory

GetCharacters

IsCategory

IsSeparatorOrWhitespaceControl

IsWhitespace

TextToLines

ToLineEnding

NativeLineEnding