RouteMatchList class
The list of RouteMatch objects.
This corresponds to the GoRouter's history.
- Annotations
Constructors
-
RouteMatchList({required List<
RouteMatch> matches, required Uri uri, Object? extra, GoException? error, required Map<String, String> pathParameters}) - RouteMatchList constructor.
Properties
- error → GoException?
-
An exception if there was an error during matching.
final
- extra → Object?
-
An extra object to pass along with the navigation.
final
- fullPath → String
-
the full path pattern that matches the uri.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- isEmpty → bool
-
Returns true if there are no matches.
no setter
- isError → bool
-
Returns true if the current match intends to display an error screen.
no setter
- isNotEmpty → bool
-
Returns true if there are matches.
no setter
- last → RouteMatch
-
The last matching route.
no setter
-
matches
→ List<
RouteMatch> -
The route matches.
final
-
pathParameters
→ Map<
String, String> -
Parameters for the matched route, URI-encoded.
final
-
routes
→ List<
RouteBase> -
The routes for each of the matches.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uri → Uri
-
The uri of the current match.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
push(
ImperativeRouteMatch match) → RouteMatchList -
Returns a new instance of RouteMatchList with the input
matchpushed onto the current instance. -
remove(
RouteMatch match) → RouteMatchList -
Returns a new instance of RouteMatchList with the input
matchremoved from the current instance. -
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Static Properties
- empty ↔ RouteMatchList
-
Constructs an empty matches object.
getter/setter pair