GoRouteInformationParser class

Converts between incoming URLs and a RouteMatchList using RouteMatcher.

Integrates the top-level onEnter guard. Legacy top-level redirect is adapted and executed inside the parse pipeline after onEnter allows; the parser handles route-level redirects after that.

Inheritance

Constructors

GoRouteInformationParser({required RouteConfiguration configuration, required GoRouter router, required ParserExceptionHandler? onParserException})
Creates a GoRouteInformationParser.

Properties

configuration → RouteConfiguration
The route configuration used for parsing RouteInformations.
final
debugParserFuture ↔ Future<RouteMatchList>?
The future of current route parsing (used for testing asynchronous redirection).
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
onParserException → ParserExceptionHandler?
Exception handler for parser errors.
final
router → GoRouter
The router instance.
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
parseRouteInformation(RouteInformation routeInformation) → Future<RouteMatchList>
Converts the given route information into parsed data to pass to a RouterDelegate.
override
parseRouteInformationWithDependencies(RouteInformation routeInformation, BuildContext context) → Future<RouteMatchList>
Converts the given route information into parsed data to pass to a RouterDelegate.
override
restoreRouteInformation(RouteMatchList configuration) → RouteInformation?
Restore the route information from the given configuration.
override
toString() → String
A string representation of this object.
inherited

Operators

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