Struct XCTestSuiteRun

Source

pub struct XCTestSuiteRun { /* private fields */ }

Expand description

Apple’s documentation

Implementations§

Source §

impl XCTestSuiteRun

Methods declared on superclass XCTestRun.

Source

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

Source

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

Source

pub fn testRunWithTest(test: &XCTest) -> Retained<Self>

Class factory method for the XCTestRun class.

Parameter test: An XCTest instance.

Returns: A test run for the provided test.

Source

pub fn initWithTest(this: Allocated<Self>, test: &XCTest) -> Retained<Self>

Designated initializer for the XCTestRun class.

Parameter test: An XCTest instance.

Returns: A test run for the provided test.

Methods from Deref<Target = XCTestRun>§

Source

pub fn test(&self) -> Retained<XCTest>

The test instance provided when the test run was initialized.

Source

pub fn start(&self)

Start a test run. Must not be called more than once.

Source

pub fn stop(&self)

Stop a test run. Must not be called unless the run has been started. Must not be called more than once.

Source

pub fn startDate(&self) -> Option<Retained<NSDate>>

The time at which the test run was started, or nil.

Source

pub fn stopDate(&self) -> Option<Retained<NSDate>>

The time at which the test run was stopped, or nil.

Source

pub fn totalDuration(&self) -> NSTimeInterval

The number of seconds that elapsed between when the run was started and when it was stopped.

Source

pub fn testDuration(&self) -> NSTimeInterval

The number of seconds that elapsed between when the run was started and when it was stopped.

Source

pub fn testCaseCount(&self) -> NSUInteger

The number of tests in the run.

Source

pub fn executionCount(&self) -> NSUInteger

The number of test executions recorded during the run.

Source

pub fn skipCount(&self) -> NSUInteger

The number of test skips recorded during the run.

Source

pub fn failureCount(&self) -> NSUInteger

The number of test failures recorded during the run.

Source

pub fn unexpectedExceptionCount(&self) -> NSUInteger

The number of uncaught exceptions recorded during the run.

Source

pub fn totalFailureCount(&self) -> NSUInteger

The total number of test failures and uncaught exceptions recorded during the run.

Source

pub fn hasSucceeded(&self) -> bool

YES if all tests in the run completed their execution without recording any failures, otherwise NO.

Source

pub fn hasBeenSkipped(&self) -> bool

YES if the test was skipped, otherwise NO.

Source

pub fn recordIssue(&self, issue: &XCTIssue)

Records a failure or other issue in the execution of the test and is used by all test assertions. Overrides of this method should call super unless they wish to suppress the issue. Super can be invoked with a different issue object.

Parameter issue: Object with all details related to the issue.

Source

pub fn recordFailureWithDescription_inFile_atLine_expected( &self, description: &NSString, file_path: Option<&NSString>, line_number: NSUInteger, expected: bool, )

👎Deprecated

Records a failure in the execution of the test for this test run. Must not be called unless the run has been started. Must not be called if the test run has been stopped.

This method is deprecated and has been replaced by the -recordIssue: method and XCTIssue class, which provide greater flexibility for recording issues that arise during testing. Overriding this method in an XCTestRun subclass and modifying its arguments before calling super may cause information about the failure to be lost and is not recommended. Instead, override -recordIssue: and pass super a modified XCTIssue.

Parameter description: The description of the failure being recorded. When replacing usage of this deprecated API, this can be represented using the compactDescription property on XCTIssue.

Parameter filePath: The file path to the source file where the failure being recorded was encountered or nil if unknown. When replacing usage of this deprecated API, this can be specified using an XCTSourceCodeLocation instance associated with an XCTIssue via its sourceCodeContext property.

Parameter lineNumber: The line number in the source file at filePath where the failure being recorded was encountered or 0 if unknown. When replacing usage of this deprecated API, this can be specified using an XCTSourceCodeLocation instance associated with an XCTIssue via its sourceCodeContext property.

Parameter expected: NO if the failure being recorded was the result of an uncaught exception, YES if it was the result of a failed assertion or any other reason. When replacing usage of this deprecated API, the representation using XCTIssue may vary. A NO value may be specified using the issue type XCTIssueTypeUncaughtException, and a YES value may be represented using a different issue type such as XCTIssueTypeAssertionFailure combined with other properties on XCTIssue.

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