reaktiv-navigation/io.github.syrou.reaktiv.navigation/NavigationOutcome

NavigationOutcome

Result of a NavigationLogic.navigate call.

Callers can ignore the return value for fire-and-forget behaviour (same as before), or inspect it to react to specific outcomes.

Example:

val outcome = navLogic.navigate { navigateTo(ProfileScreen) }
if (outcome is NavigationOutcome.Dropped) {
    // another navigation was in progress, retry or notify the user
}

Inheritors

Types

Dropped

data object Dropped : NavigationOutcome

Navigation was silently dropped because another navigation was already in progress.

Redirected

data class Redirected(val to: String) : NavigationOutcome

Navigation was redirected by a guard.

Rejected

data object Rejected : NavigationOutcome

Navigation was rejected by a guard.

Success

data object Success : NavigationOutcome

Navigation was executed successfully.