Struct SCNetworkProtocol

#[repr(C)]
pub struct SCNetworkProtocol { /* private fields */ }

Available on crate feature SCNetworkConfiguration only.

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

See also Apple’s documentation

Implementations

impl SCNetworkProtocol

pub fn configuration( self: &SCNetworkProtocol, ) -> Option<CFRetained<CFDictionary>>

Returns the configuration settings associated with the protocol.

Parameter protocol: The network protocol.

Returns: The configuration settings associated with the protocol; NULL if no configuration settings are associated with the protocol or an error was encountered.

pub fn enabled(self: &SCNetworkProtocol) -> bool

Returns whether this protocol has been enabled.

Parameter protocol: The network protocol.

Returns: TRUE if the protocol is enabled.

pub fn protocol_type(self: &SCNetworkProtocol) -> Option<CFRetained<CFString>>

Returns the associated network protocol type.

Parameter protocol: The network protocol.

Returns: The protocol type.

pub unsafe fn set_configuration( self: &SCNetworkProtocol, config: Option<&CFDictionary>, ) -> bool

Stores the configuration settings for the protocol.

Parameter protocol: The network protocol.

Parameter config: The configuration settings to associate with this protocol.

Returns: TRUE if the configuration was stored; FALSE if an error was encountered.

pub fn set_enabled(self: &SCNetworkProtocol, enabled: bool) -> bool

Enables or disables the protocol.

Parameter protocol: The network protocol.

Parameter enabled: TRUE if the protocol should be enabled.

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

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 SCNetworkProtocol

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for SCNetworkProtocol

fn as_ref(&self) -> &CFType

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

impl AsRef<SCNetworkProtocol> for SCNetworkProtocol

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNetworkProtocol

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SCNetworkProtocol

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SCNetworkProtocol

fn type_id() -> CFTypeID

Returns the type identifier of all SCNetworkProtocol instances.

impl Debug for SCNetworkProtocol

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

Formats the value using the given formatter.

impl Deref for SCNetworkProtocol

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNetworkProtocol

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 SCNetworkProtocol

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SCNetworkProtocol

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 SCNetworkProtocol

const ENCODING_REF: Encoding

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

impl Type for SCNetworkProtocol

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 SCNetworkProtocol