FilesystemSanitiserResult class

Object to return from any filesystem sanitiser defined in FMTCSettings.filesystemSanitiser

FilesystemSanitiserResult.validOutput must be sanitised to be safe enough to be used in the filesystem. FilesystemSanitiserResult.errorMessages can be empty if there were no changes to the input. Alternatively, it can be one or more messages describing the issue with the input.

If the method is used internally in a validation situation, the output must be equal to the input, otherwise the error messages are thrown. This is, for example, the situation when managing stores and names. If the method is used internally in a sanitisation situation, error messages are ignored. This is, for example, the situation when storing map tiles.

Constructors

FilesystemSanitiserResult({required String validOutput, List<String> errorMessages = const []})

Object to return from any filesystem sanitiser defined in FMTCSettings.filesystemSanitiser

Properties

errorMessages → List<String>

Can be empty (default) if there were no changes to the input. Alternatively, it can be one or more messages describing the issue with the input.

final

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

validOutput → String

Must be sanitised to be safe enough to be used in the filesystem

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override