commonMain.com.copperleaf.ballast.navigation.routing.UnmatchedDestination.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ballast-navigation Show documentation

Simple URL-based navigation library built on top of Ballast

There is a newer version: 4.2.1

package com.copperleaf.ballast.navigation.routing

import com.copperleaf.ballast.navigation.internal.Uri

/**
 * Represents a URL that was parsed, and can be used to match against a [Route] in a [RoutingTable].
 */
public data class UnmatchedDestination(
    val originalDestinationUrl: String,

    val matchablePathSegments: List,
    val matchableQueryParameters: Map>,

    public val extraAnnotations: Set,
) {
    public companion object {
        public fun parse(
            destinationUrl: String,
            extraAnnotations: Set = emptySet(),
        ): UnmatchedDestination {
            val url = Uri.parse(destinationUrl)

            return UnmatchedDestination(
                originalDestinationUrl = destinationUrl,
                matchablePathSegments = url.decodedPathSegments,
                matchableQueryParameters = url.decodedQueryParameters,
                extraAnnotations = extraAnnotations,
            )
        }
    }
}