Struct unidirs::ServiceDirs

pub struct ServiceDirs { /* fields omitted */ }

Service directories are used for applications that run as a service (or often call daemon), usually run by a dedicated user account and controlled by the system rather than the user.

The directories are therefore rather global and close to the system instead of being located in the user’s home directory.

Unix (Linux, Mac OS and others)

On Unix systems the service folders are mostly standardized. Depending on how a service is run on Mac OS, the UserDirs might be correct as well, but for system-run services the correct folders are the same as on other Unix systems.

Type	Location
Cache	/var/cache/<app>
Config	/etc/<app>
Data	/var/lib/<app>

Windows

On Windows there are three standard service accounts: LocalService, NetworkService and LocalSystem. These present different capabilities and a network service provides a middle ground with minimal capabilities plus networking access.

The API might be extended to pick the type of service account in the future.

Type	Location
Cache	C:\Windows\ServiceProfiles\NetworkService\AppData\<org>\<app>\Local\cache
Config	C:\Windows\ServiceProfiles\NetworkService\AppData\<org>\<app>\Roaming\config
Data	C:\Windows\ServiceProfiles\NetworkService\AppData\<org>\<app>\Roaming\data

Implementations

impl ServiceDirs

pub fn new(organization: impl AsRef<str>, application: impl AsRef<str>) -> Self

Create a new instance with the given organization and application name. The organization name is only used on Windows systems.

Examples

use unidirs::{Directories, ServiceDirs};

let dirs = ServiceDirs::new("example", "app");

println!("data_dir = {}", dirs.data_dir());
// On Unix:    /var/lib/app
// On Windows: C:\Windows\ServiceProfiles\NetworkService\AppData\example\app\data

Trait Implementations

impl Clone for ServiceDirs

fn clone(&self) -> ServiceDirs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceDirs

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

Formats the value using the given formatter.

impl Directories for ServiceDirs

fn cache_dir(&self) -> &Utf8Path

The cache directory is a location where an application can save any temporary data. The contents can potentially be deleted by the system at any time. Therefore, the application must be able to work without these files or be able to re-create them.

fn config_dir(&self) -> &Utf8Path

The config directory is where an application’s settings are stored. These are usually created by the user and loaded once at startup of the application.

fn data_dir(&self) -> &Utf8Path

The data directory hold an application’s state data, like a database. The folder is expected to persist during the normal runtime of the OS.

impl Hash for ServiceDirs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ServiceDirs

fn cmp(&self, other: &ServiceDirs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ServiceDirs> for ServiceDirs

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ServiceDirs> for ServiceDirs

fn partial_cmp(&self, other: &ServiceDirs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ServiceDirs

impl StructuralEq for ServiceDirs

impl StructuralPartialEq for ServiceDirs