Struct system_configuration::dynamic_store::SCDynamicStore

pub struct SCDynamicStore(_);

Access to the key-value pairs in the dynamic store of a running system.

Use the SCDynamicStoreBuilder to create instances of this.

Implementations

impl SCDynamicStore

pub fn get_keys<S: Into<CFString>>(
    &self,
    pattern: S
) -> Option<CFArray<CFString>>

Returns the keys that represent the current dynamic store entries that match the specified pattern. Or None if an error occured.

pattern - A regular expression pattern used to match the dynamic store keys.

pub fn get_proxies(&self) -> Option<CFDictionary<CFString, CFType>>

Returns the key-value pairs that represent the current internet proxy settings. Or None if no proxy settings have been defined or if an error occured.

pub fn get<S: Into<CFString>>(&self, key: S) -> Option<CFPropertyList>

If the given key exists in the store, the associated value is returned.

Use CFPropertyList::downcast_into to cast the result into the correct type.

pub fn set<S: Into<CFString>, V: CFPropertyListSubClass>(
    &self,
    key: S,
    value: V
) -> bool

Sets the value of the given key. Overwrites existing values. Returns true on success, false on failure.

pub fn set_raw<S: Into<CFString>>(&self, key: S, value: &CFPropertyList) -> bool

Sets the value of the given key. Overwrites existing values. Returns true on success, false on failure.

pub fn remove<S: Into<CFString>>(&self, key: S) -> bool

Removes the value of the specified key from the dynamic store.

pub fn set_notification_keys<T1, T2>(
    &self,
    keys: &CFArray<T1>,
    patterns: &CFArray<T2>
) -> bool

Specifies a set of keys and key patterns that should be monitored for changes.

pub fn create_run_loop_source(&self) -> CFRunLoopSource

Creates a run loop source object that can be added to the application's run loop.

Trait Implementations

impl Clone for SCDynamicStore

fn clone(&self) -> SCDynamicStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteCFType for SCDynamicStore

impl Drop for SCDynamicStore

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SCDynamicStore

impl PartialEq<SCDynamicStore> for SCDynamicStore

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TCFType for SCDynamicStore

type Ref = SCDynamicStoreRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> SCDynamicStoreRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: SCDynamicStoreRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Get Rule". The reference count is bumped.

fn as_CFTypeRef(&self) -> CFTypeRef

Returns the object as a raw CFTypeRef. The reference count is not adjusted.

unsafe fn wrap_under_create_rule(reference: SCDynamicStoreRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Create Rule". The reference count is not bumped.

fn type_id() -> CFTypeID

Returns the type ID for this class.

fn as_CFType(&self) -> CFType

Returns the object as a wrapped CFType. The reference count is incremented by one.

fn into_CFType(self) -> CFType

Returns the object as a wrapped CFType. Consumes self and avoids changing the reference count.

fn retain_count(&self) -> isize

Returns the reference count of the object. It is unwise to do anything other than test whether the return value of this method is greater than zero.

fn type_of(&self) -> usize

Returns the type ID of this object.

fn show(&self)

Writes a debugging version of this object on standard error.

fn instance_of<OtherCFType>(&self) -> bool where
    OtherCFType: TCFType, 

Returns true if this value is an instance of another type.

impl<'a> ToVoid<SCDynamicStore> for &'a SCDynamicStore

fn to_void(&self) -> *const c_void

impl ToVoid<SCDynamicStore> for SCDynamicStore

fn to_void(&self) -> *const c_void

impl ToVoid<SCDynamicStore> for SCDynamicStoreRef

fn to_void(&self) -> *const c_void