Struct XCTIssue

Source

pub struct XCTIssue { /* private fields */ }

Expand description

Encapsulates all data concerning a test failure or other issue.

Implementations§

Source §

impl XCTIssue

Source

pub fn initWithType_compactDescription_detailedDescription_sourceCodeContext_associatedError_attachments( this: Allocated<Self>, type: XCTIssueType, compact_description: &NSString, detailed_description: Option<&NSString>, source_code_context: &XCTSourceCodeContext, associated_error: Option<&NSError>, attachments: &NSArray<XCTAttachment>, ) -> Retained<Self>

Source

pub fn initWithType_compactDescription_detailedDescription_sourceCodeContext_associatedError_attachments_severity( this: Allocated<Self>, type: XCTIssueType, compact_description: &NSString, detailed_description: Option<&NSString>, source_code_context: &XCTSourceCodeContext, associated_error: Option<&NSError>, attachments: &NSArray<XCTAttachment>, severity: XCTIssueSeverity, ) -> Retained<Self>

Source

pub fn initWithType_compactDescription_severity( this: Allocated<Self>, type: XCTIssueType, compact_description: &NSString, severity: XCTIssueSeverity, ) -> Retained<Self>

Source

pub fn initWithType_compactDescription( this: Allocated<Self>, type: XCTIssueType, compact_description: &NSString, ) -> Retained<Self>

Source

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

Source

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

Source

pub fn type(&self) -> XCTIssueType

The type of the issue.

Source

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

A concise description of the issue, expected to be free of transient data and suitable for use in test run summaries and for aggregation of results across multiple test runs.

Source

pub fn detailedDescription(&self) -> Option<Retained<NSString>>

A detailed description of the issue designed to help diagnose the issue. May include transient data such as numbers, object identifiers, timestamps, etc.

Source

pub fn sourceCodeContext(&self) -> Retained<XCTSourceCodeContext>

The source code location (file and line number) and the call stack associated with the issue.

Source

pub fn associatedError(&self) -> Option<Retained<NSError>>

Error associated with the issue.

Source

pub fn attachments(&self) -> Retained<NSArray<XCTAttachment>>

All attachments associated with the issue.

Source

pub fn severity(&self) -> XCTIssueSeverity

The severity of the issue.

Source

pub fn isFailure(&self) -> bool

Whether or not this issue should cause the test it’s associated with to be considered a failure.

The value of this property is YES for issues which have a severity level of XCTIssueSeverityError or higher. Otherwise, the value of this property is NO.

Use this property to determine if an issue should be considered a failure, instead of directly comparing the value of the severity property.

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