Struct ODNode

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

Available on crate feature ODNode only.

This class is used to work with OpenDirectory nodes.

OpenDirectory uses nodes to represent different sources of directory information, via the local disk, LDAP, etc.

See also Apple’s documentation

Implementations

impl ODNode

pub unsafe fn nodeWithSession_type_error( in_session: Option<&ODSession>, in_type: ODNodeType, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<Self>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODSession only.

Create an autoreleased ODNode of the given type, optionally in a specific session.

Autoreleased instance of an ODNode with a provided ODSession and ODNodeType. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn nodeWithSession_name_error( in_session: Option<&ODSession>, in_name: Option<&NSString>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<Self>>

Available on crate feature ODSession only.

Create an autoreleased ODNode with the given name, optionally in a specific session.

autoreleased instance of an ODNode with a provided ODSession and node name. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn initWithSession_type_error( this: Allocated<Self>, in_session: Option<&ODSession>, in_type: ODNodeType, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<Self>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODSession only.

Initialize an ODNode instance of the given type, optionally in a specific session.

initialize instance of an ODNode with a provided ODSession and ODNodeType. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn initWithSession_name_error( this: Allocated<Self>, in_session: Option<&ODSession>, in_name: Option<&NSString>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<Self>>

Available on crate feature ODSession only.

Initialize an ODNode instance with the given name, optionally in a specific session.

initialize instance of an ODNode with a provided ODSession and node name. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn subnodeNamesAndReturnError( &self, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSArray>>

Returns NSArray of node names for this node, which may contain sub-nodes or search policy nodes

Returns NSArray of node names for this node, which may contain sub-nodes or search policy nodes. Commonly used with Search policy nodes. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn unreachableSubnodeNamesAndReturnError( &self, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSArray>>

Will return NSArray of names of subnodes that are not currently reachable.

Will return NSArray of names of subnodes that are not currently reachable. Commonly used with Search policy nodes to determine if any nodes are currently unreachable, but may also return other subnodes if the OpenDirectory plugin supports. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn nodeName(&self) -> Retained<NSString>

The node name.

The node name, corresponding to its path in OpenDirectory.

pub unsafe fn nodeDetailsForKeys_error( &self, in_keys: Option<&NSArray>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSDictionary>>

Returns a dictionary of information about the instance of ODNode

Returns a dictionary of information about the instance of ODNode. Details such as Trust information (kODAttributeTypeTrustInformation) or other Node details can be retrieved. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn supportedRecordTypesAndReturnError( &self, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSArray>>

Returns a NSArray of the record types supported by this node.

Returns a NSArray of the record types supported by this node. If node does not support the check then all possible types will be returned. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn supportedAttributesForRecordType_error( &self, in_record_type: Option<&ODRecordType>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSArray>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

Will return a list of attribute types supported for that attribute if possible

Will return a list of attribute types supported for that attribute if possible. If no specific types are available, then all possible values will be returned instead. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn setCredentialsWithRecordType_recordName_password_error( &self, in_record_type: Option<&ODRecordType>, in_record_name: Option<&NSString>, in_password: Option<&NSString>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

Sets the credentials for interaction with the ODNode

Sets the credentials for interaction with the ODNode. Record references, etc. will use these credentials to query or change data. Setting the credentials on a node referenced by other OD object types will change the credentials for all for all references. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn setCredentialsWithRecordType_authenticationType_authenticationItems_continueItems_context_error( &self, in_record_type: Option<&ODRecordType>, in_type: Option<&ODAuthenticationType>, in_items: Option<&NSArray>, out_items: Option<&mut Option<Retained<NSArray>>>, out_context: Option<&mut Option<Retained<AnyObject>>>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

Allows use of other OpenDirectory types of authentications to set the credentials for an ODNode

Allows the caller to use other types of authentications that are available in OpenDirectory, that may require response-request loops, etc. Not all OD plugins will support this call, look for kODErrorCredentialsMethodNotSupported in outError. outError is optional parameter, nil can be passed if error details is not needed.

pub unsafe fn setCredentialsUsingKerberosCache_error( &self, in_cache_name: Option<&NSString>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Unsupported method.

Unsupported method.

pub unsafe fn createRecordWithRecordType_name_attributes_error( &self, in_record_type: Option<&ODRecordType>, in_record_name: Option<&NSString>, in_attributes: Option<&NSDictionary>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<ODRecord>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODRecord only.

Creates a record in this node, using the given name and attributes.

Takes all the provided attributes and type to create an entire record. The function will assign a UUID to the record automatically. This UUID can be overwritten by the client by passing with the other attributes. inAttributes is optional, nil can be passed if no other attributes are to be set.

pub unsafe fn recordWithRecordType_name_attributes_error( &self, in_record_type: Option<&ODRecordType>, in_record_name: Option<&NSString>, in_attributes: Option<&AnyObject>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<ODRecord>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODRecord only.

Returns an ODRecord object that references the requested type and name

Returns an ODRecord object that references the requested type and name. The record will have cached the attributes requested. Further attributes can be requested via ODRecord APIs. For performance it is best to ask for as many attributes that are needed as possible up front.

pub unsafe fn customCall_sendData_error( &self, in_custom_code: NSInteger, in_send_data: Option<&NSData>, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSData>>

Sends a custom code to the node; input and output data formats are specific to the call.

Sends a custom code to the node; input and output data formats are specific to the call. outError is optional parameter, nil can be passed if error details are not needed.

pub unsafe fn customFunction_payload_error( &self, function: Option<&NSString>, payload: Option<&AnyObject>, error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<AnyObject>>

Sends a custom function call to the node; data is a type specific to the call.

Sends a custom function call to the node; data is a type specific to the call. ‘error’ is an optional parameter therefore nil can be passed if error details are not needed. Return type is defined by the custom function requested.

pub unsafe fn configuration(&self) -> Option<Retained<ODConfiguration>>

Available on crate feature ODConfiguration only.

Returns an ODConfiguration object for the node.

Returns an ODConfiguration object for the node.

pub unsafe fn policiesAndReturnError( &self, error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSDictionary>>

👎Deprecated: use accountPoliciesAndReturnError:

This will copy any policies configured for the node.

This will copy any policies configured for the node.

pub unsafe fn supportedPoliciesAndReturnError( &self, error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSDictionary>>

👎Deprecated

This will return a dictionary of supported policies.

This will return a dictionary of supported policies, if appropriate, the value will be the maximum value allowed for the policy in question. For example, if password history is available, it will state how much history is supported.

pub unsafe fn setPolicies_error( &self, policies: Option<&NSDictionary>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated: use setAccountPolicies:error:

This will set the policy for the node.

This will set the policy for the node. Policies are evaluated in combination with record-level policies.

pub unsafe fn setPolicy_value_error( &self, policy: Option<&ODPolicyType>, value: Option<&AnyObject>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated: use addAccountPolicy:toCategory:error:

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

This will set a specific policy setting for the node.

This will set a specific policy setting for the node.

pub unsafe fn removePolicy_error( &self, policy: Option<&ODPolicyType>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated: use removeAccountPolicy:fromCategory:error:

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

This will remove a specific policy setting from the node.

This will remove a specific policy setting from the node.

pub unsafe fn addAccountPolicy_toCategory_error( &self, policy: Option<&NSDictionary>, category: Option<&ODPolicyCategoryType>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

This will add an account policy to the node for the specified category.

This will add an account policy to the node for the specified category. The specified policy will be applied to all users in the specified node when policies are evaluated.

Parameter policy: a dictionary containing the specific policy to be added. The dictionary may contain the following keys: kODPolicyKeyIdentifier a required key identifying the policy. kODPolicyKeyParameters an optional key containing a dictionary of parameters that can be used for informational purposes or in the policy format string. kODPolicyKeyContent a required key specifying the policy, from which a predicate will be created for evaluating the policy.

Parameter category: a valid ODPolicyCategoryType to which the specified policy will be added.

Parameter error: an optional NSError reference for error details.

Returns: a BOOL which signifies if the policy addition succeeded, otherwise error is set.

pub unsafe fn removeAccountPolicy_fromCategory_error( &self, policy: Option<&NSDictionary>, category: Option<&ODPolicyCategoryType>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants only.

This will remove an account policy from the node for the specified category.

This will remove an account policy from the node for the specified category.

Parameter policy: a dictionary containing the specific policy to be removed, with the same format as described in addAccountPolicy.

Parameter category: a valid ODPolicyCategoryType from which the specified policy will be removed.

Parameter error: an optional NSError reference for error details.

Returns: a BOOL which signifies if the policy removal succeeded, otherwise error is set.

pub unsafe fn setAccountPolicies_error( &self, policies: Option<&NSDictionary>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

This will set the policies for the node.

This will set the policies for the node, replacing any existing policies. All of the policies in the set will be applied to all users in the specified node when policies are evaluated.

Parameter policies: a dictionary containing all of the policies to be set for the node. The dictionary may contain the following keys: kODPolicyCategoryAuthentication an optional key with a value of an array of policy dictionaries that specify when authentications should be allowed. kODPolicyCategoryPasswordContent an optional key with a value of an array of policy dictionaries the specify the required content of passwords. kODPolicyCategoryPasswordChange an optional key with a value of an array of policy dictionaries that specify when passwords are required to be changed.

Parameter error: an optional NSError reference for error details.

Returns: a BOOL which signifies if the policy set succeeded, otherwise error is set.

pub unsafe fn accountPoliciesAndReturnError( &self, error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<NSDictionary>>

Returns a dictionary containing any policies configured for the node.

Returns a dictionary containing any policies configured for the node.

Parameter error: an optional NSError reference for error details.

Returns: an NSDictionary containing all currently set policies. The format of the dictionary is the same as described in setAccountPolicies.

pub unsafe fn passwordContentCheck_forRecordName_error( &self, password: Option<&NSString>, record_name: Option<&NSString>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Validates a password against the node’s password content policies.

Validates a password against the node’s password content policies. The node’s password content policies will be evaluated to determine if the password is acceptable. May be used prior to creating the record.

This check is only definitive at the time it was requested. The policy or the environment could change before the password change is actually requested. Errors from the password change request should be consulted.

Parameter password: the password to be evaluated against the content policies.

Parameter recordName: the name of the record.

Parameter error: an optional NSError reference for error details.

Returns: a bool which signifies if the password passes all content policies, otherwise error is set.

impl ODNode

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for ODNode

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for ODNode

fn as_ref(&self) -> &NSObject

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

impl AsRef<ODNode> for ODNode

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for ODNode

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ODNode

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ODNode

const NAME: &'static str = "ODNode"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ODNode as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for ODNode

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

Formats the value using the given formatter.

impl Deref for ODNode

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ODNode

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 ODNode

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ODNode

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for ODNode

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 ODNode

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for ODNode

impl Eq for ODNode