oskit-kmp/com.outsidesource.oskitkmp.router/IRoutePopScope

IRoutePopScope

interface IRoutePopScope

The scope all pop operations are performed in

Functions

Link copied to clipboard
open fun once(): (route: RouteStackEntry) -> Boolean

Pops the top route off of the stack unless it is the only route. This is the default operation.

Link copied to clipboard
open fun <T : IRoute> toClass(to: KClass<T>, inclusive: Boolean = false): (route: RouteStackEntry) -> Boolean

Pops to a specified class

Link copied to clipboard
open fun toRoute(to: IRoute, inclusive: Boolean = false): (route: RouteStackEntry) -> Boolean

Pops to a specified Route

Link copied to clipboard
open fun whileTrue(predicate: (RouteStackEntry) -> Boolean): (route: RouteStackEntry) -> Boolean

Pops while a specified condition is true. This is a convenience function for readability.

Link copied to clipboard
abstract fun withResult(result: Any): (route: RouteStackEntry) -> Boolean

Pops the top route off of the stack and sets the route's result to the provided result. This should be used in conjunction with IRouter.transactionWithResult