Struct DeepLinkConfig 

pub struct DeepLinkConfig {
    pub schemes: Vec<String>,
    pub domains: Vec<String>,
    pub path_prefixes: Vec<String>,
}

Declarative runtime filter for inbound deep links.

Fields

schemes: Vec<String>

domains: Vec<String>

path_prefixes: Vec<String>

Implementations

impl DeepLinkConfig

pub fn new() -> Self

Creates an empty deep-link configuration.

Add schemes, domains, and optional path prefixes before installing it in a shell. An empty config intentionally matches no URLs.

pub fn scheme(self, scheme: impl Into<String>) -> Self

Allows a custom URL scheme.

scheme is normalized by trimming whitespace, removing a trailing colon, and lowercasing. Use this for routes such as myapp://item/123.

pub fn domain(self, domain: impl Into<String>) -> Self

Allows an HTTP or HTTPS domain.

domain is normalized by trimming whitespace, removing a trailing dot, and lowercasing. Use this for app links, universal links, and web routes that should enter the Fission app.

pub fn path_prefix(self, prefix: impl Into<String>) -> Self

Restricts accepted links to a path prefix.

Prefixes are normalized to start with /. Add one or more prefixes when only part of a domain should route into the app, such as /invite or /checkout.

pub fn is_empty(&self) -> bool

Returns true when no scheme, domain, or path rule has been configured.

Empty configs match no URLs. This prevents a shell from accidentally accepting every external URL before the app has declared its routes.

pub fn matches(&self, url: &str) -> bool

Returns whether a URL is accepted by this deep-link configuration.

url is parsed as a simple absolute URL. The URL matches when its scheme or domain is allowed and, if path prefixes were configured, its path starts with one of those prefixes.

pub fn source_for(&self, url: &str) -> DeepLinkSource

Classifies a URL according to this configuration.

Use this in shell code when creating DeepLinkReceived actions. The result distinguishes configured custom schemes and associated domains from ordinary web URLs or external URLs.

Trait Implementations

impl Clone for DeepLinkConfig

fn clone(&self) -> DeepLinkConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeepLinkConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DeepLinkConfig

fn default() -> DeepLinkConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeepLinkConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeepLinkConfig

fn eq(&self, other: &DeepLinkConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeepLinkConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DeepLinkConfig

impl StructuralPartialEq for DeepLinkConfig