Struct XCTExpectedFailureOptions

Source

pub struct XCTExpectedFailureOptions { /* private fields */ }

Expand description

Describes the rules for matching issues to expected failures and other behaviors related to expected failure handling.

Implementations§

Source §

impl XCTExpectedFailureOptions

Source

pub unsafe fn issueMatcher( &self, ) -> NonNull<DynBlock<dyn Fn(NonNull<XCTIssue>) -> Bool>>

Available on crate feature block2 only.

An optional filter can be used to determine whether or not an issue recorded inside an expected failure block should be matched to the expected failure. Issues that are not matched to an expected failure will be recorded as normal issues (real test failures). By default the filter is nil and all issues are matched.

§Safety

The returned block’s argument must be a valid pointer.

Source

pub fn setIssueMatcher( &self, issue_matcher: &DynBlock<dyn Fn(NonNull<XCTIssue>) -> Bool>, )

Available on crate feature block2 only.

Setter for issueMatcher.

This is copied when set.

Source

pub fn isEnabled(&self) -> bool

For expected failures that only occur under certain circumstances, this flag can be used to disable the expected failure. In the closure-based variants of XCTExpectFailure, the failing block will be executed normally. Defaults to YES/true.

Source

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

Source

pub fn isStrict(&self) -> bool

If true (the default) and no issue is matched to the expected failure, then an issue will be recorded for the unmatched expected failure itself.

Source

pub fn setStrict(&self, strict: bool)

Setter for isStrict.

Source

pub fn nonStrictOptions() -> Retained<XCTExpectedFailureOptions>

Convenience factory method which returns a new instance of XCTExpectedFailureOptions that has isStrict set to NO, with every other value set to its default.

Source §

impl XCTExpectedFailureOptions

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

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