Struct XCTestSuite 

pub struct XCTestSuite { /* private fields */ }

A concrete subclass of XCTest, XCTestSuite is a collection of test cases. Suites are usually managed by the IDE, but XCTestSuite also provides API for dynamic test and suite management:

    XCTestSuite *suite = [XCTestSuite testSuiteWithName:@"My tests"];
    [suite addTest:[MathTest testCaseWithSelector:@selector(testAdd)]];
    [suite addTest:[MathTest testCaseWithSelector:@selector(testDivideByZero)]];

Alternatively, a test suite can extract the tests to be run automatically. To do so, pass the class of your test case class to the suite’s constructor:

    XCTestSuite *suite = [XCTestSuite testSuiteForTestCaseClass:[MathTest class]];

This creates a suite with all the methods starting with “test” that take no arguments. Also, a test suite of all the test cases found in the runtime can be created automatically:

    XCTestSuite *suite = XCTestSuite.defaultTestSuite;

This creates a suite of suites with all the XCTestCase subclasses methods that start with “test” and take no arguments.

See also Apple’s documentation

Implementations

impl XCTestSuite

pub fn defaultTestSuite() -> Retained<XCTestSuite>

pub fn testSuiteForBundlePath(bundle_path: &NSString) -> Retained<Self>

pub fn testSuiteForTestCaseWithName(name: &NSString) -> Retained<Self>

pub unsafe fn testSuiteForTestCaseClass( test_case_class: &AnyClass, ) -> Retained<Self>

Safety

test_case_class probably has further requirements.

pub fn testSuiteWithName(name: &NSString) -> Retained<Self>

pub fn initWithName(this: Allocated<Self>, name: &NSString) -> Retained<Self>

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

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

pub fn addTest(&self, test: &XCTest)

pub fn tests(&self) -> Retained<NSArray<XCTest>>

Methods from Deref<Target = XCTest>

pub fn testCaseCount(&self) -> NSUInteger

Number of test cases. Must be overridden by subclasses.

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

Test’s name. Must be overridden by subclasses.

pub fn testRunClass(&self) -> Option<&'static AnyClass>

The XCTestRun subclass that will be instantiated when the test is run to hold the test’s results. Must be overridden by subclasses.

pub fn testRun(&self) -> Option<Retained<XCTestRun>>

The test run object that executed the test, an instance of testRunClass. If the test has not yet been run, this will be nil.

pub fn performTest(&self, run: &XCTestRun)

The method through which tests are executed. Must be overridden by subclasses.

pub fn runTest(&self)

Creates an instance of the testRunClass and passes it as a parameter to -performTest:.

pub fn setUpWithCompletionHandler( &self, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Asynchronous set up method called before the invocation of each test method in the class. This method is called before invoking setUpWithError, setUp, and the test method.

Parameter completion: A block which must be called to signal completion of set up. May be called asynchronously. If the block’s error argument is non-nil, the specified error is recorded as a thrown error issue.

pub fn setUpWithError(&self) -> Result<(), Retained<NSError>>

This method is called before invoking setUp and the test method.

pub fn setUp(&self)

Setup method called before the invocation of each test method in the class.

pub fn tearDown(&self)

Teardown method called after the invocation of each test method in the class.

pub fn tearDownWithError(&self) -> Result<(), Retained<NSError>>

This method is called after invoking the test method (if applicable) and tearDown.

pub fn tearDownWithCompletionHandler( &self, completion: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Asynchronous tear down method called after invoking the test method. This method is called after invoking the test method (if applicable), tearDown, and tearDownWithError.

Parameter completion: A block which must be called to signal completion of tear down. May be called asynchronously. If the block’s error argument is non-nil, the specified error is recorded as a thrown error issue.

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 XCTestSuite

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for XCTestSuite

fn as_ref(&self) -> &NSObject

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

impl AsRef<XCTest> for XCTestSuite

fn as_ref(&self) -> &XCTest

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

impl AsRef<XCTestSuite> for XCTestSuite

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for XCTestSuite

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for XCTestSuite

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<XCTest> for XCTestSuite

fn borrow(&self) -> &XCTest

Immutably borrows from an owned value.

impl ClassType for XCTestSuite

const NAME: &'static str = "XCTestSuite"

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

type Super = XCTest

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for XCTestSuite

type Target = XCTest

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for XCTestSuite

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 XCTestSuite

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for XCTestSuite

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 XCTestSuite

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 XCTestSuite

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

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

impl DowncastTarget for XCTestSuite

impl Eq for XCTestSuite