Struct Preferences 

pub struct Preferences;

Provides operations for reading, writing, deleting, and managing macOS plist preference files in user or global domains.

Implementations

impl Preferences

pub fn list_domains() -> Result<HashSet<Domain>>

List all available domains.

pub fn find(word: &str) -> Result<HashMap<Domain, Vec<FindMatch>>>

Search all domains for keys or values containing the given word (case-insensitive).

pub fn read(domain: Domain, key: &str) -> Result<PrefValue>

Read a value from the given domain and key.

pub fn read_domain(domain: Domain) -> Result<PrefValue>

Read an entire domain.

pub fn write(domain: Domain, key: &str, value: PrefValue) -> Result<()>

Write a value to the given domain and key.

If the domain file does not exist, it will be created. If the key already exists, its value will be overwritten.

pub fn delete(domain: Domain, key: &str) -> Result<()>

Delete a key from the given domain.

pub fn delete_domain(domain: Domain) -> Result<()>

Delete a whole domain.

pub fn read_type(domain: Domain, key: &str) -> Result<String>

Read the type of a value at the given key in the specified domain.

Returns a string describing the type.

pub fn rename(domain: Domain, old_key: &str, new_key: &str) -> Result<()>

Rename a key in the given domain.

Moves the value from old_key to new_key within the domain plist.

pub fn import(domain: Domain, import_path: &str) -> Result<()>

Import a plist file into the specified domain.

Replaces any existing file for the domain.

pub fn export(domain: Domain, export_path: &str) -> Result<()>

Export a domain’s plist file to the specified path.