Struct SCNetworkSet 

pub struct SCNetworkSet { /* private fields */ }

Available on crate feature SCNetworkConfiguration only.

This is the type of a reference to an object that represents a network set.

See also Apple’s documentation

Implementations

impl SCNetworkSet

pub fn add_service(&self, service: &SCNetworkService) -> bool

Adds the network service to the set.

Parameter set: The network set.

Parameter service: The service to be added.

Returns: TRUE if the service was added to the set; FALSE if the service was already present or an error was encountered.

Note: prior to Mac OS X 10.5, the Network Preferences UI did not support having a single service being a member of more than one set. An error will be returned if you attempt to add a service to more than one set on a pre-10.5 system.

pub fn contains_interface(&self, interface: &SCNetworkInterface) -> bool

Checks if an interface is represented by at least one network service in the specified set.

Parameter set: The network set.

Parameter interface: The network interface.

Returns: TRUE if the interface is represented in the set; FALSE if not.

pub fn all(prefs: &SCPreferences) -> Option<CFRetained<CFArray>>

Available on crate feature SCPreferences only.

Returns all available sets for the specified preferences.

Parameter prefs: The “preferences” session.

Returns: The list of SCNetworkSet sets associated with the preferences. You must release the returned value.

pub fn current(prefs: &SCPreferences) -> Option<CFRetained<SCNetworkSet>>

Available on crate feature SCPreferences only.

Returns the “current” set.

Parameter prefs: The “preferences” session.

Returns: The current set; NULL if no current set has been defined.

pub fn services(&self) -> Option<CFRetained<CFArray>>

Returns all network services associated with the set.

Parameter set: The network set.

Returns: The list of SCNetworkService services associated with the set. You must release the returned value.

pub fn new(prefs: &SCPreferences) -> Option<CFRetained<SCNetworkSet>>

Available on crate feature SCPreferences only.

Create a new set in the configuration.

Parameter prefs: The “preferences” session.

Returns: A reference to the new SCNetworkSet. You must release the returned value.

pub fn copy( prefs: &SCPreferences, set_id: &CFString, ) -> Option<CFRetained<SCNetworkSet>>

Available on crate feature SCPreferences only.

Returns the set with the specified identifier.

Parameter prefs: The “preferences” session.

Parameter setID: The unique identifier for the set.

Returns: A reference to the SCNetworkSet from the associated preferences; NULL if the setID does not exist in the preferences or if an error was encountered. You must release the returned value.

pub fn name(&self) -> Option<CFRetained<CFString>>

Returns the [user specified] name associated with the set.

Parameter set: The network set.

Returns: The [user specified] name.

pub fn set_id(&self) -> Option<CFRetained<CFString>>

Returns the identifier for the set.

Parameter set: The network set.

Returns: The set identifier.

pub fn service_order(&self) -> Option<CFRetained<CFArray>>

Returns the [user specified] ordering of network services within the set.

Parameter set: The network set.

Returns: The ordered list of CFStringRef service identifiers associated with the set; NULL if no service order has been specified or if an error was encountered.

pub fn remove(&self) -> bool

Removes the set from the configuration.

Parameter set: The network set.

Returns: TRUE if the set was removed; FALSE if an error was encountered.

pub fn remove_service(&self, service: &SCNetworkService) -> bool

Removes the network service from the set.

Parameter set: The network set.

Parameter service: The service to be removed.

Returns: TRUE if the service was removed from the set; FALSE if the service was not already present or an error was encountered.

pub fn set_current(&self) -> bool

Specifies the set that should be the “current” set.

Parameter set: The network set.

Returns: TRUE if the current set was updated; FALSE if an error was encountered.

pub fn set_name(&self, name: Option<&CFString>) -> bool

Stores the [user specified] name for the set.

Parameter set: The network set.

Parameter name: The [user defined] name to associate with the set.

Returns: TRUE if the name was saved; FALSE if an error was encountered.

Note: although not technically required, the [user specified] names for all set should be unique. As such, an error will be returned if you attemp to name two sets with the same string.

pub unsafe fn set_service_order(&self, new_order: &CFArray) -> bool

Stores the [user specified] ordering of network services for the set.

Parameter set: The network set.

Parameter newOrder: The ordered list of CFStringRef service identifiers for the set.

Returns: TRUE if the new service order was saved; FALSE if an error was encountered.

Safety

new_order generic must be of the correct type.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for SCNetworkSet

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CFType> for SCNetworkSet

fn as_ref(&self) -> &CFType

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SCNetworkSet> for SCNetworkSet

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for SCNetworkSet

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SCNetworkSet

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SCNetworkSet

fn type_id() -> CFTypeID

Returns the type identifier of all SCNetworkSet instances.

impl Debug for SCNetworkSet

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

Formats the value using the given formatter.

impl Deref for SCNetworkSet

type Target = CFType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for SCNetworkSet

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for SCNetworkSet

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SCNetworkSet

fn eq(&self, other: &Self) -> 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 RefEncode for SCNetworkSet

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for SCNetworkSet

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for SCNetworkSet