StringEscape

Description

[ShutdownSurvive]
sealed class Tinman.Core.Formatting.StringEscape

Helper class for setting up rules for string escaping.

Public / Constants

LineSingleQuote

public static readonly attribute LineSingleQuote → (StringEscape)

Common escaping rules capturing strings in a single line, enclosed by single quotes.

['] (0x22) => [\'] (0x5C, 0x22)
[ ] (0x09) => [\t] (0x5C, 0x74)
[ ] (0x0A) => [\n] (0x5C, 0x6E)
[ ] (0x0D) => [\r] (0x5C, 0x72)
[\] (0x5C) => [\\] (0x5C, 0x5C)

None

public static readonly attribute None → (StringEscape)

No string escaping.

Public / Methods

Add

_2 overloads

public method Add¹ → (1)

rule ⁱⁿ : IStringOp: [not-null]
The reversible string operation that represents the string escaping rule to add.
returns → StringEscape: this

Adds the given string escaping rule.

public method Add² → (3)

plain ⁱⁿ : string: [not-empty]
The plain token.
escaped ⁱⁿ : string: [not-empty]
The escaped token.
direction ^opt : int32 = 0: The escape processing direction:
= 0 : both directions
> 0 : plain ⁱⁿ to escaped ⁱⁿ
< 0 : escaped ⁱⁿ to plain ⁱⁿ
returns → StringEscape: The resulting StringEscape object.

Adds the given plain/escaped pair to this string escape object.

Escape

public method Escape → (2)

plain ⁱⁿ : string: The plain string.
escape ^opt : ICharacterEscape = null: An optional escape rule that depicts whether a character must be escaped because it cannot be used at the target site. If null, CharacterEscape.Never will be used.
returns → string: The escaped string.

Escapes the given plain string by applying all escaping rules.

Unescape

public method Unescape → (2)

escaped ⁱⁿ : string: The escaped string.
escape ^opt : ICharacterEscape = null: An optional escape rule that depicts whether a character must be escaped because it cannot be used at the target site. If null, CharacterEscape.Never will be used.
returns → string: The plain string.

Unescapes the given escaped string by reversing all escaping rules.

Public / Attributes

IsReversible

[Constant]
public attribute IsReversible → (get)

value : bool: true if all string escaping rules are reversible,
false if some are irreversible.

Checks if all string escaping rules are reversible.

See also: IStringOp.IsReversible