RmlCommitDiff class
The outcome of diffing a sandbox markup document against its base
(rmlCommitDiff): either errors from compiling one of the two
documents, or a classified change set ready to apply to the live file.
Constructors
-
RmlCommitDiff.failure(List<
RmlCompileError> errors, {bool baseFailed = false}) -
const
-
RmlCommitDiff.success({required Uint8List changes, required int idsUsed, required List<
RmlCommitEntry> entries, required List<RmlCommitSkip> skipped, required List<RmlOrderGroup> orders}) -
const
Properties
- baseFailed → bool
-
Whether it was the base document, rather than the sandbox, that failed
to compile. Meaningless when errors is empty.
final
- changes → Uint8List?
-
The ChangeSet wire bytes; null exactly on failure.
final
-
entries
→ List<
RmlCommitEntry> -
final
-
errors
→ List<
RmlCompileError> -
Compile errors; set only on failure, in which case every field below is
empty.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- idsUsed → int
-
final
- isSuccess → bool
-
no setter
-
orders
→ List<
RmlOrderGroup> -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
skipped
→ List<
RmlCommitSkip> -
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromJson(
String report, Uint8List? changes) → RmlCommitDiff - Reads the report JSON native sends across FFI/wasm, pairing it with the ChangeSet bytes sent alongside (null on failure). Never throws: text that is not the expected JSON shape becomes one error, as in RmlCompileError.listFromJson.