Struct ODQuery 

pub struct ODQuery { /* private fields */ }

Available on crate feature ODQuery only.

Class used for querying OpenDirectory.

OpenDirectory queries may be used to search for different types of records, e.g. users, groups.

See also Apple’s documentation

Implementations

impl ODQuery

pub unsafe fn queryWithNode_forRecordTypes_attribute_matchType_queryValues_returnAttributes_maximumResults_error( in_node: Option<&ODNode>, in_record_type_or_list: Option<&AnyObject>, in_attribute: Option<&ODAttributeType>, in_match_type: ODMatchType, in_query_value_or_list: Option<&AnyObject>, in_return_attribute_or_list: Option<&AnyObject>, in_maximum_results: NSInteger, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<ODQuery>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODNode only.

Creates an autoreleased query with the node using the parameters provided

Creates an autoreleased query with the node using the supplied query parameters. Some parameters can either be NSString or NSData or an NSArray of either NSString or NSData. Passing nil for returnAttributes is equivalent to passing kODAttributeTypeStandardOnly. outError is optional parameter, nil can be passed if error details are not needed.

Safety

• in_node might not allow None.
• in_record_type_or_list should be of the correct type.
• in_record_type_or_list might not allow None.
• in_attribute might not allow None.
• in_query_value_or_list should be of the correct type.
• in_query_value_or_list might not allow None.
• in_return_attribute_or_list should be of the correct type.
• in_return_attribute_or_list might not allow None.
• out_error might not allow None.

pub unsafe fn initWithNode_forRecordTypes_attribute_matchType_queryValues_returnAttributes_maximumResults_error( this: Allocated<Self>, in_node: Option<&ODNode>, in_record_type_or_list: Option<&AnyObject>, in_attribute: Option<&ODAttributeType>, in_match_type: ODMatchType, in_query_value_or_list: Option<&AnyObject>, in_return_attribute_or_list: Option<&AnyObject>, in_maximum_results: NSInteger, out_error: Option<&mut Option<Retained<NSError>>>, ) -> Option<Retained<Self>>

Available on crate features CFOpenDirectory and CFOpenDirectoryConstants and ODNode only.

Creates a query with the node using the parameters provided

Creates a query with the node using the supplied query parameters. Some parameters can either be NSString or NSData or an NSArray of either NSString or NSData. Passing nil for returnAttributes is equivalent to passing kODAttributeTypeStandardOnly. outError is optional parameter, nil can be passed if error details are not needed.

Safety

• in_node might not allow None.
• in_record_type_or_list should be of the correct type.
• in_record_type_or_list might not allow None.
• in_attribute might not allow None.
• in_query_value_or_list should be of the correct type.
• in_query_value_or_list might not allow None.
• in_return_attribute_or_list should be of the correct type.
• in_return_attribute_or_list might not allow None.
• out_error might not allow None.

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

Returns results from a provided ODQuery synchronously

Returns results from a provided ODQuery synchronously. Passing NO to inAllowPartialResults will block the call until all results are returned or an error occurs. YES can be passed at any time even if previous calls were made with NO. outError is optional parameter, nil can be passed if error details are not needed.

Safety

out_error might not allow None.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn ODQueryDelegate>>>

The currently set delegate

The query delegate which will receive asynchronous query results.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn ODQueryDelegate>>, )

Setter for delegate.

Safety

• delegate might not allow None.
• This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn scheduleInRunLoop_forMode( &self, in_run_loop: Option<&NSRunLoop>, in_mode: Option<&NSString>, )

Adds the query object to the specified NSRunLoop to receive asynchronous results

Adds the query object to the specified NSRunLoop to receive asynchronous results. A delegate must be set in advance otherwise results may be lost due to the lack of a receiver.

Safety

• in_run_loop possibly has additional threading requirements.
• in_run_loop might not allow None.
• in_mode might not allow None.

pub unsafe fn removeFromRunLoop_forMode( &self, in_run_loop: Option<&NSRunLoop>, in_mode: Option<&NSString>, )

Removes the query object from the specified NSRunLoop

Removes the query object from the specified NSRunLoop.

Safety

• in_run_loop possibly has additional threading requirements.
• in_run_loop might not allow None.
• in_mode might not allow None.

pub unsafe fn synchronize(&self)

Will dispose of any results and restart the query.

Will dispose of any results and restart the query for subsequent resultsAllowingPartial: calls. If the query is currently scheduled on a RunLoop, then the delegate will be called with inResults == nil and [inError code] == kODErrorQuerySynchronize and [inError domain] == ODFrameworkErrorDomain, signifying that all existing results should be thrown away in preparation for new results.

pub unsafe fn operationQueue(&self) -> Option<Retained<NSOperationQueue>>

The NSOperationQueue on which asynchronous results are delivered to the delegate.

The NSOperationQueue on which asynchronous results are delivered to the delegate.

pub unsafe fn setOperationQueue( &self, operation_queue: Option<&NSOperationQueue>, )

Setter for operationQueue.

Safety

• operation_queue possibly has additional threading requirements.
• operation_queue might not allow None.

impl ODQuery

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 ODQuery

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for ODQuery

fn as_ref(&self) -> &NSObject

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

impl AsRef<ODQuery> for ODQuery

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for ODQuery

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ODQuery

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ODQuery

const NAME: &'static str = "ODQuery"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ODQuery 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 CopyingHelper for ODQuery

type Result = ODQuery

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for ODQuery

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

Formats the value using the given formatter.

impl Deref for ODQuery

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ODQuery

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 ODQuery

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for ODQuery

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for ODQuery

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 ODQuery

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 ODQuery

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

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

impl DowncastTarget for ODQuery

impl Eq for ODQuery