IStringOp

Description

interface Tinman.Core.Formatting.IStringOp

A single operation during string escaping.

public method Process → (4)

input ⁱⁿ : string: [not-null]
The input string.
offset ⁱⁿ : int32: [0..input.Length]
Offset into input ⁱⁿ to the first character of the sequence to process.
output ⁱⁿ : StringBuilder: The builder to use for outputting the processed character sequence or null to probe whether processing would be performed (see return value).
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 → int32: The value of offset ⁱⁿ, plus the number of characters in input ⁱⁿ that have been processed. If equal to offset ⁱⁿ, this string operation will not have performed any processing. May be 1- iff output ⁱⁿ is null to indicate that processing will be performed and that this method needs to be called again with a string builder.

Processes the character sequence in input ⁱⁿ starting at the given offset ⁱⁿ.

public method Reverse → ()

returns → IStringOp: The reverse string operation or null iff the modification is irreversible.

Returns a string operation that reverses the modification of this string operation.

public attribute IsReversible → (get)

value : bool: true if this string operation is reversible,
false if it is irreversible.

Is this string operation reversible?