StringScanner class

A class that scans through a string using Patterns.

Implementers

Constructors

StringScanner(String string, {Object? sourceUrl, int? position})
Creates a new StringScanner that starts scanning from position.

Properties

hashCode → int
The hash code for this object.
no setterinherited
isDone → bool
Whether the scanner has completely consumed string.
no setter
lastMatch → Match?
The data about the previous match made by the scanner.
no setter
position ↔ int
The current position of the scanner in the string, in characters.
getter/setter pair
rest → String
The portion of the string that hasn't yet been scanned.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceUrl → Uri?
The URL of the source of the string being scanned.
final
string → String
The string being scanned through.
final

Methods

error(String message, {Match? match, int? position, int? length}) → Never
Throws a FormatException with message as well as a detailed description of the location of the error in the string.
expect(Pattern pattern, {String? name}) → void
If pattern matches at the current position of the string, scans forward until the end of the match.
expectChar(int character, {String? name}) → void
If the next character in the string is character, consumes it.
expectDone() → void
If the string has not been fully consumed, this throws a FormatException.
matches(Pattern pattern) → bool
Returns whether or not pattern matches at the current position of the string.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
peekChar([int? offset]) → int?
Returns the character code of the character offset away from position.
peekCodePoint() → int?
Returns the Unicode code point immediately after position.
readChar() → int
Consumes a single character and returns its character code.
readCodePoint() → int
Consumes a single Unicode code unit and returns it.
scan(Pattern pattern) → bool
If pattern matches at the current position of the string, scans forward until the end of the match.
scanChar(int character) → bool
If the next character in the string is character, consumes it.
substring(int start, [int? end]) → String
Returns the substring of string between start and end.
toString() → String
A string representation of this object.
inherited

Operators

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