Struct ClaimOptions 

pub struct ClaimOptions {
    pub legacy_identifier: Option<String>,
    pub hold_legacy: bool,
}

Options for SingleInstance::claim_with_options.

Fields

legacy_identifier: Option<String>

The Tauri identifier (tauri.conf.json) the legacy tauri-plugin-single-instance keyed its endpoint by. When set, a live legacy holder is probed first and receives this launch, and an unreachable one is a ClaimFailure::Legacy. None skips the probe.

hold_legacy: bool

With legacy_identifier: also HOLD and SERVICE the legacy claim while this process is the primary, so an older build (on the plugin) launched later finds a live holder, forwards its launch and exits, instead of starting a second instance. Default false.

The launch the old build forwards (its cwd and argv) reaches the same on_message callback, on a dedicated thread, as an InstanceMessage with no action. The claim is released by SingleInstance::destroy or by dropping the guard: the service thread is stopped and joined, and the mutex, window or socket is gone when that returns.

Order, which makes it atomic with becoming primary: the primary endpoint is hosted first; only the process that won it takes the legacy claim, so two new builds cannot both hold it. If a live old build already holds the legacy claim, the primary is released and this launch is forwarded to it, as without this option. A second launch of the new build never probes the legacy claim; it forwards over the typed channel.

Do not combine with tauri_plugin_single_instance registered in the same process: both would claim the same names. Windows and macOS only; on Linux (D-Bus) the hold is a no-op.

Implementations

impl ClaimOptions

pub fn with_legacy(identifier: &str) -> Self

Probe, and forward to, a live legacy holder keyed by identifier.

pub fn holding_legacy(self) -> Self

Also hold and service the legacy claim (see ClaimOptions::hold_legacy).

Trait Implementations

impl Clone for ClaimOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClaimOptions

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

Formats the value using the given formatter.

impl Default for ClaimOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ClaimOptions

impl PartialEq for ClaimOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClaimOptions