Struct DesktopApp 

pub struct DesktopApp { /* private fields */ }

A small convenience wrapper around common Windows desktop app identity tasks.

DesktopApp keeps a validated app identity in one place and uses it for app-data paths and single-instance locking. It does not own any global state.

Examples

let app = win_desktop_utils::DesktopApp::new(format!(
    "demo-app-{}",
    std::process::id()
))?;

let local = app.ensure_local_data_dir()?;
assert!(local.exists());

Implementations

impl DesktopApp

pub fn new(app_name: impl Into<String>) -> Result<Self>

Creates a desktop app identity without a company namespace.

Errors

Returns Error::InvalidInput if app_name is empty, contains NUL bytes, or contains characters that are invalid in Windows file names.

pub fn with_company( company_name: impl Into<String>, app_name: impl Into<String>, ) -> Result<Self>

Creates a desktop app identity grouped under a company namespace.

App-data paths are nested as Company\App, while the default single-instance mutex ID uses Company.App.

Errors

Returns Error::InvalidInput if either identity part is empty, contains NUL bytes, or contains characters that are invalid in Windows file names.

pub fn instance_scope(self, scope: InstanceScope) -> Self

Sets the default single-instance mutex namespace scope used by Self::single_instance.

pub fn company_name(&self) -> Option<&str>

Returns the optional company name.

pub fn app_name(&self) -> &str

Returns the app name.

pub fn app_dir_name(&self) -> &str

Returns the app-data directory name used by the paths helpers.

pub fn app_id(&self) -> &str

Returns the default app ID used by the single-instance helpers.

pub fn configured_instance_scope(&self) -> InstanceScope

Returns the configured single-instance scope.

pub fn local_data_dir(&self) -> Result<PathBuf>

Returns the per-user local app-data directory for this app without creating it.

pub fn roaming_data_dir(&self) -> Result<PathBuf>

Returns the per-user roaming app-data directory for this app without creating it.

pub fn ensure_local_data_dir(&self) -> Result<PathBuf>

Creates and returns the per-user local app-data directory for this app.

pub fn ensure_roaming_data_dir(&self) -> Result<PathBuf>

Creates and returns the per-user roaming app-data directory for this app.

pub fn single_instance_options(&self) -> SingleInstanceOptions

Returns single-instance options for this app.

pub fn single_instance(&self) -> Result<Option<InstanceGuard>>

Attempts to acquire the configured single-instance guard for this app.

Trait Implementations

impl Clone for DesktopApp

fn clone(&self) -> DesktopApp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DesktopApp

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

Formats the value using the given formatter.

impl PartialEq for DesktopApp

fn eq(&self, other: &DesktopApp) -> 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 Eq for DesktopApp

impl StructuralPartialEq for DesktopApp