Struct ODSessionRef

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

Available on crate feature CFOpenDirectory only.

Opaque reference for ODSession object

See also Apple’s documentation

Implementations

impl ODSessionRef

pub unsafe fn new( allocator: Option<&CFAllocator>, options: Option<&CFDictionary>, error: *mut *mut CFError, ) -> Option<CFRetained<ODSessionRef>>

Available on crate features CFODSession and objc2-core-foundation only.

Creates an ODSession object to be passed to ODNode functions

Creates an ODSession object to be passed to ODNode functions.

Parameter allocator: a memory allocator to use for this object

Parameter options: a CFDictionary of options associated with this ODSession. This is typically NULL unless caller needs to proxy to another host.

If proxy is required then a dictionary with keys should be: Key Value kODSessionProxyAddress CFString(hostname or IP) kODSessionProxyPort CFNumber(IP port, should not be set as it will default) kODSessionProxyUsername CFString(username) kODSessionProxyPassword CFString(password)

Parameter error: an optional CFErrorRef reference for error details

Returns: a valid ODSessionRef object or NULL if it cannot be created. Pass reference to CFErrorRef to get error details

pub unsafe fn node_names( allocator: Option<&CFAllocator>, session: Option<&ODSessionRef>, error: *mut *mut CFError, ) -> Option<CFRetained<CFArray>>

Available on crate features CFODSession and objc2-core-foundation only.

Returns the node names that are registered on this ODSession

Returns the node names that are registered on this ODSession

Parameter allocator: a memory allocator to use for this object

Parameter session: an ODSessionRef, either kODSessionDefault or a valid ODSessionRef can be passed

Parameter error: an optional CFErrorRef reference for error details

Returns: a valid CFArrayRef of node names that can be opened on the session reference

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 ODSessionRef

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for ODSessionRef

fn as_ref(&self) -> &CFType

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

impl AsRef<ODSessionRef> for ODSessionRef

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for ODSessionRef

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for ODSessionRef

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for ODSessionRef

Available on crate features CFODSession and objc2-core-foundation only.

fn type_id() -> CFTypeID

Standard GetTypeID function support for CF-based objects

Returns the typeID for ODSession objects

Returns: a valid CFTypeID for the ODSession object

impl Debug for ODSessionRef

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

Formats the value using the given formatter.

impl Deref for ODSessionRef

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ODSessionRef

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 ODSessionRef

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for ODSessionRef

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 ODSessionRef

const ENCODING_REF: Encoding

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

impl Type for ODSessionRef

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 ODSessionRef