Struct XCTKVOExpectation

Source

pub struct XCTKVOExpectation { /* private fields */ }

Expand description

Expectation subclass for waiting on a condition defined Key Value Observation of a key path for an object.

Implementations§

Source §

pub unsafe fn initWithDescription( this: Allocated<Self>, expectation_description: &NSString, ) -> Retained<Self>

Source

pub unsafe fn initWithKeyPath_object_expectedValue_options( this: Allocated<Self>, key_path: &NSString, object: &AnyObject, expected_value: Option<&AnyObject>, options: NSKeyValueObservingOptions, ) -> Retained<Self>

Initializes an expectation that is fulfilled when a key value coding compliant change is made such that the specified key path of the observed object has the expected value.

§Safety

object should be of the correct type.
expected_value should be of the correct type.

Source

pub unsafe fn initWithKeyPath_object_expectedValue( this: Allocated<Self>, key_path: &NSString, object: &AnyObject, expected_value: Option<&AnyObject>, ) -> Retained<Self>

Initializes an expectation that is fulfilled when a key value coding compliant change is made such that the specified key path of the observed object has the expected value. The NSKeyValueObservingOptions passed for this initializer include NSKeyValueObservingOptionInitial, so the object/key path will be checked immediately. The options also include NSKeyValueObservingOptionNew and NSKeyValueObservingOptionOld, so if a handler is used the change dictionary passed to it will contain NSKeyValueChangeNewKey and NSKeyValueChangeOldKey entries.

§Safety

object should be of the correct type.
expected_value should be of the correct type.

Source

pub unsafe fn initWithKeyPath_object( this: Allocated<Self>, key_path: &NSString, object: &AnyObject, ) -> Retained<Self>

Convenience initializer that is fulfilled by any change to the specified key path of the observed object. The NSKeyValueObservingOptions passed for this initializer do not include NSKeyValueObservingOptionInitial since there is no value to check. If that behavior is desired in conjunction with a handler, use the designated initializer. The options do include NSKeyValueObservingOptionNew and NSKeyValueObservingOptionOld, so if a handler is used the change dictionary passed to it will contain NSKeyValueChangeNewKey and NSKeyValueChangeOldKey entries.

§Safety

object should be of the correct type.

Source

pub fn keyPath(&self) -> Retained<NSString>

Returns the key path that is being monitored for the KVO change.

Source

pub fn observedObject(&self) -> Retained<AnyObject>

Returns the object that is being monitored for the KVO change.

Source

pub fn expectedValue(&self) -> Option<Retained<AnyObject>>

Returns the value that the expectation is waiting for the observed object/key path to have.

Source

pub fn options(&self) -> NSKeyValueObservingOptions

The KVO options used when the expectation registered for observation.

Source

pub unsafe fn handler(&self) -> XCKeyValueObservingExpectationHandler

Available on crate feature block2 only.

Allows the caller to install a special handler to do custom evaluation of the change to the value of the object/key path. If a handler is set, expectedValue will be ignored.

§Safety

The returned block must be sendable.

Source

pub unsafe fn setHandler(&self, handler: XCKeyValueObservingExpectationHandler)

Available on crate feature block2 only.

Setter for handler.

This is copied when set.

§Safety

handler must be a valid pointer or null.

Methods from Deref<Target = XCTestExpectation>§

Source

pub fn expectationDescription(&self) -> Retained<NSString>

The human readable string used to describe the expectation in log output and test reports.

Source

pub fn setExpectationDescription(&self, expectation_description: &NSString)

Setter for expectationDescription.

This is copied when set.

Source

pub fn isInverted(&self) -> bool

If an expectation is set to have inverted behavior, then fulfilling it will have a similar effect that failing to fulfill a conventional expectation has, as handled by the waiter and its delegate. Furthermore, waiters that wait on an inverted expectation will allow the full timeout to elapse and not report timeout to the delegate if it is not fulfilled.

Source

pub fn setInverted(&self, inverted: bool)

Setter for isInverted.

Source

pub unsafe fn expectedFulfillmentCount(&self) -> NSUInteger

The expectedFulfillmentCount is the number of times -fulfill must be called on the expectation in order for it to report complete fulfillment to its waiter. By default, expectations have an expectedFufillmentCount of 1. This value must be greater than 0 and is not meaningful if combined with @ inverted.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setExpectedFulfillmentCount( &self, expected_fulfillment_count: NSUInteger, )

Setter for expectedFulfillmentCount.

§Safety

This might not be thread-safe.

Source

pub unsafe fn assertForOverFulfill(&self) -> bool

If set, calls to fulfill() after the expectation has already been fulfilled - exceeding the fulfillment count - will raise. This is the legacy behavior of expectations created through APIs on XCTestCase but is not enabled for expectations created using XCTestExpectation initializers.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setAssertForOverFulfill(&self, assert_for_over_fulfill: bool)

Setter for assertForOverFulfill.

§Safety

This might not be thread-safe.

Source

pub fn fulfill(&self)

Call -fulfill to mark an expectation as having been met. It’s an error to call -fulfill on an expectation more times than its expectedFulfillmentCount value specifies, or when the test case that vended the expectation has already completed. If assertForOverFulfill is set when either of these occur, -fulfill will raise an exception.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}