Struct XCTWaiter 

pub struct XCTWaiter { /* private fields */ }

Manages waiting - pausing the current execution context - for an array of XCTestExpectations. Waiters can be used with or without a delegate to respond to events such as completion, timeout, or invalid expectation fulfillment. XCTestCase conforms to the delegate protocol and will automatically report timeouts and other unexpected events as test failures.

Waiters can be used without a delegate or any association with a test case instance. This allows test support libraries to provide convenience methods for waiting without having to pass test cases through those APIs.

See also Apple’s documentation

Implementations

impl XCTWaiter

pub fn initWithDelegate( this: Allocated<Self>, delegate: Option<&ProtocolObject<dyn XCTWaiterDelegate>>, ) -> Retained<Self>

Creates a new waiter with the specified delegate.

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

The waiter delegate will be called with various events described in <XCTWaiterDelegate

.

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

Setter for delegate.

This is a weak property.

pub fn fulfilledExpectations(&self) -> Retained<NSArray<XCTestExpectation>>

Returns an array containing the expectations that were fulfilled, in that order, up until the waiter stopped waiting. Expectations fulfilled after the waiter stopped waiting will not be in the array. The array will be empty until the waiter has started waiting, even if expectations have already been fulfilled. If a waiter is used to wait multiple times, this array will contain all of the fulfilled expectations from each wait operation.

pub fn waitForExpectations( &self, expectations: &NSArray<XCTestExpectation>, ) -> XCTWaiterResult

Waits on a group of expectations indefinitely.

Parameter expectations: An array of expectations that must be fulfilled.

The test will continue to run until _expectations_are fulfilled or the test reaches its execution time allowance.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Enabling test timeouts is recommended when using this method to prevent a runaway expectation from hanging the test.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_timeout( &self, expectations: &NSArray<XCTestExpectation>, seconds: NSTimeInterval, ) -> XCTWaiterResult

Waits on a group of expectations for up to the specified timeout.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter seconds: The number of seconds within which all expectations must be fulfilled.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_enforceOrder( &self, expectations: &NSArray<XCTestExpectation>, enforce_order_of_fulfillment: bool, ) -> XCTWaiterResult

Waits on a group of expectations indefinitely, optionally enforcing their order of fulfillment.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter enforceOrderOfFulfillment: If YES,the expectations specified by the _expectations_parameter must be satisfied in the order they appear in the array.

The test will continue to run until _expectations_are fulfilled or the test reaches its execution time allowance.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Enabling test timeouts is recommended when using this method to prevent a runaway expectation from hanging the test.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_timeout_enforceOrder( &self, expectations: &NSArray<XCTestExpectation>, seconds: NSTimeInterval, enforce_order_of_fulfillment: bool, ) -> XCTWaiterResult

Waits on a group of expectations for up to the specified timeout, optionally enforcing their order of fulfillment.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter seconds: The number of seconds within which all expectations must be fulfilled.

Parameter enforceOrderOfFulfillment: If YES,the expectations specified by the _expectations_parameter must be satisfied in the order they appear in the array.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_class( expectations: &NSArray<XCTestExpectation>, ) -> XCTWaiterResult

Creates a waiter that waits on a group of expectations indefinitely.

Parameter expectations: An array of expectations that must be fulfilled.

The test will continue to run until _expectations_are fulfilled or the test reaches its execution time allowance.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Enabling test timeouts is recommended when using this method to prevent a runaway expectation from hanging the test.

The waiter is discarded when the wait completes.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_timeout_class( expectations: &NSArray<XCTestExpectation>, seconds: NSTimeInterval, ) -> XCTWaiterResult

Creates a waiter that waits on a group of expectations for up to the specified timeout.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter seconds: The number of seconds within which all expectations must be fulfilled.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

The waiter is discarded when the wait completes.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_enforceOrder_class( expectations: &NSArray<XCTestExpectation>, enforce_order_of_fulfillment: bool, ) -> XCTWaiterResult

Creates a waiter that waits on a group of expectations indefinitely, optionally enforcing their order of fulfillment.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter enforceOrderOfFulfillment: If YES,the expectations specified by the _expectations_parameter must be satisfied in the order they appear in the array.

The test will continue to run until _expectations_are fulfilled or the test reaches its execution time allowance.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

Enabling test timeouts is recommended when using this method to prevent a runaway expectation from hanging the test.

The waiter is discarded when the wait completes.

Returns: A value describing the outcome of waiting for expectations.

pub fn waitForExpectations_timeout_enforceOrder_class( expectations: &NSArray<XCTestExpectation>, seconds: NSTimeInterval, enforce_order_of_fulfillment: bool, ) -> XCTWaiterResult

Creates a waiter that waits on a group of expectations for up to the specified timeout, optionally enforcing their order of fulfillment.

Parameter expectations: An array of expectations that must be fulfilled.

Parameter seconds: The number of seconds within which all expectations must be fulfilled.

Parameter enforceOrderOfFulfillment: If YES,the expectations specified by the _expectations_parameter must be satisfied in the order they appear in the array.

Expectations can only appear in the list once. This method may return early based on fulfillment of the provided expectations.

The waiter is discarded when the wait completes.

Returns: A value describing the outcome of waiting for expectations.

impl XCTWaiter

Methods declared on superclass NSObject.

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

pub 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 XCTWaiter

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for XCTWaiter

fn as_ref(&self) -> &NSObject

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

impl AsRef<XCTWaiter> for XCTWaiter

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for XCTWaiter

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for XCTWaiter

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for XCTWaiter

const NAME: &'static str = "XCTWaiter"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<XCTWaiter 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 XCTWaiter

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

Formats the value using the given formatter.

impl DefaultRetained for XCTWaiter

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for XCTWaiter

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for XCTWaiter

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 XCTWaiter

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for XCTWaiter

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 XCTWaiter

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 XCTWaiter

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

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

impl DowncastTarget for XCTWaiter

impl Eq for XCTWaiter

impl Send for XCTWaiter

impl Sync for XCTWaiter