Struct Preferences 

pub struct Preferences { /* private fields */ }

Implementations

impl Preferences

pub fn type_id() -> u64

pub fn new(name: &str, prefs_id: Option<&str>) -> Result<Self>

Examples found in repository

examples/07_network_sets.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.network-sets-example", None)?;
    let current = NetworkSet::copy_current(&prefs).and_then(|set| set.name());
    println!("current_set={current:?}");
    for set in NetworkSet::copy_all(&prefs) {
        println!("set_id={:?} name={:?} services={}", set.set_id(), set.name(), set.copy_services().len());
    }
    Ok(())
}

examples/06_network_services.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.network-services-example", None)?;
    for service in prefs.network_services() {
        println!(
            "id={:?} enabled={} name={:?} protocols={}",
            service.service_id()?,
            service.is_enabled(),
            service.name()?,
            service.copy_protocols().len()
        );
    }
    Ok(())
}

examples/04_preferences_session.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.preferences-example", None)?;
    let keys = prefs.copy_key_list();
    println!("key_count={}", keys.len());
    if let Some(first_key) = keys.first() {
        println!("first_key={first_key}");
        println!("first_value_present={}", prefs.get_value(first_key)?.is_some());
    }
    println!("signature_present={}", prefs.signature().is_some());
    Ok(())
}

examples/09_network_protocol.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.network-protocol-example", None)?;
    if let Some(protocol) = NetworkService::copy_all(&prefs)
        .into_iter()
        .flat_map(|service| service.copy_protocols())
        .next()
    {
        println!(
            "protocol_type={:?} enabled={} has_config={}",
            protocol.protocol_type(),
            protocol.is_enabled(),
            protocol.configuration().is_some()
        );
    } else {
        println!("no network protocols available");
    }
    Ok(())
}

pub fn new_with_authorization( name: &str, prefs_id: Option<&str>, ) -> Result<Self>

pub unsafe fn new_with_authorization_raw( name: &str, prefs_id: Option<&str>, authorization: Option<NonNull<c_void>>, ) -> Result<Self>

Safety

authorization must be a valid AuthorizationRef obtained from a compatible Security-framework binding, and it must remain valid for the lifetime requirements imposed by SCPreferences.

pub fn new_with_callback<F>( name: &str, prefs_id: Option<&str>, callback: F, ) -> Result<Self>

where F: FnMut(PreferencesNotification) + Send + 'static,

pub fn new_with_authorization_and_callback<F>( name: &str, prefs_id: Option<&str>, callback: F, ) -> Result<Self>

where F: FnMut(PreferencesNotification) + Send + 'static,

pub unsafe fn new_with_authorization_raw_and_callback<F>( name: &str, prefs_id: Option<&str>, authorization: Option<NonNull<c_void>>, callback: F, ) -> Result<Self>

where F: FnMut(PreferencesNotification) + Send + 'static,

Safety

authorization must be a valid AuthorizationRef obtained from a compatible Security-framework binding, and it must remain valid for the lifetime requirements imposed by SCPreferences.

pub fn set_callback<F>(&mut self, callback: F) -> Result<()>

where F: FnMut(PreferencesNotification) + Send + 'static,

pub fn clear_callback(&mut self) -> Result<()>

pub fn schedule_with_run_loop_current(&self) -> Result<()>

pub fn unschedule_from_run_loop_current(&self) -> Result<()>

pub fn set_dispatch_queue_global(&self) -> Result<()>

pub fn clear_dispatch_queue(&self) -> Result<()>

pub fn lock(&self, wait: bool) -> Result<()>

pub fn commit_changes(&self) -> Result<()>

pub fn apply_changes(&self) -> Result<()>

pub fn unlock(&self) -> Result<()>

pub fn synchronize(&self)

pub fn signature(&self) -> Option<String>

Examples found in repository

examples/04_preferences_session.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.preferences-example", None)?;
    let keys = prefs.copy_key_list();
    println!("key_count={}", keys.len());
    if let Some(first_key) = keys.first() {
        println!("first_key={first_key}");
        println!("first_value_present={}", prefs.get_value(first_key)?.is_some());
    }
    println!("signature_present={}", prefs.signature().is_some());
    Ok(())
}

pub fn copy_key_list(&self) -> Vec<String>

Examples found in repository

examples/04_preferences_session.rs (line 5)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.preferences-example", None)?;
    let keys = prefs.copy_key_list();
    println!("key_count={}", keys.len());
    if let Some(first_key) = keys.first() {
        println!("first_key={first_key}");
        println!("first_value_present={}", prefs.get_value(first_key)?.is_some());
    }
    println!("signature_present={}", prefs.signature().is_some());
    Ok(())
}

pub fn get_value(&self, key: &str) -> Result<Option<PropertyList>>

Examples found in repository

examples/04_preferences_session.rs (line 9)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.preferences-example", None)?;
    let keys = prefs.copy_key_list();
    println!("key_count={}", keys.len());
    if let Some(first_key) = keys.first() {
        println!("first_key={first_key}");
        println!("first_value_present={}", prefs.get_value(first_key)?.is_some());
    }
    println!("signature_present={}", prefs.signature().is_some());
    Ok(())
}

pub fn add_value(&self, key: &str, value: &PropertyList) -> Result<()>

pub fn set_value(&self, key: &str, value: &PropertyList) -> Result<()>

pub fn remove_value(&self, key: &str) -> Result<()>

pub fn path_create_unique_child(&self, prefix: &str) -> Result<Option<String>>

pub fn path_get_value(&self, path: &str) -> Result<Option<PropertyList>>

pub fn path_get_link(&self, path: &str) -> Result<Option<String>>

pub fn path_set_value(&self, path: &str, value: &PropertyList) -> Result<()>

pub fn path_set_link(&self, path: &str, link: &str) -> Result<()>

pub fn path_remove_value(&self, path: &str) -> Result<()>

pub fn set_computer_name(&self, name: Option<&str>) -> Result<()>

pub fn set_local_host_name(&self, name: Option<&str>) -> Result<()>

pub fn network_services(&self) -> Vec<NetworkService>

Examples found in repository

examples/06_network_services.rs (line 5)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prefs = Preferences::new("systemconfiguration-rs.network-services-example", None)?;
    for service in prefs.network_services() {
        println!(
            "id={:?} enabled={} name={:?} protocols={}",
            service.service_id()?,
            service.is_enabled(),
            service.name()?,
            service.copy_protocols().len()
        );
    }
    Ok(())
}

Trait Implementations

impl Clone for Preferences

fn clone(&self) -> Preferences

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preferences

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

Formats the value using the given formatter.