TransliterationResult class

Exact Round-Trip envelope around any transliterated view.

The rendered string may be non-injective (Hunterian/plain English always are), but the operation remains exactly exact round-trip because original and its code points are retained. Do not discard the envelope if exact source recovery is required.

Constructors

TransliterationResult({required String original, required String normalizedInput, required String rendered, required TransliterationProfile profile, required UnicodeNormalizationForm inputNormalization, required UnicodeNormalizationForm outputNormalization, required bool renderingIsInjective, List<TransliterationIssue> issues = const <TransliterationIssue>[]})
const
TransliterationResult.fromJson(Map<String, Object?> json)
factory

Properties

exactSourceRecoveryAvailable bool
no setter
hasErrors bool
no setter
hashCode int
The hash code for this object.
no setterinherited
inputNormalization UnicodeNormalizationForm
final
issues List<TransliterationIssue>
final
normalizedInput String
final
original String
final
originalCodePoints List<int>
no setter
outputNormalization UnicodeNormalizationForm
final
profile TransliterationProfile
final
rendered String
final
renderingIsInjective bool
True only when the selected rendering is one-to-one for the admitted profile. Hunterian and plain-English views must always set this false.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
restoreOriginal() String
Exact original source, including case, NFC/NFD choice, mark order, punctuation, and aliases.
toJson() Map<String, Object?>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited