Struct XCTAttachment 

pub struct XCTAttachment { /* private fields */ }

Represents the concept of data attached to an XCTActivity. Allows reporting more context about the test run for debugging, such as screenshots, log files, and configuration dictionaries.

Each attachment must be added to an activity to be handed off to XCTest. There are two ways to get an activity:

1. XCTestCase conforms to the XCTActivity protocol, attachments can be added to it directly.
2. Create a nested activity with +[XCTContext runActivityNamed:block:], the parameter inside the block is a new activity to which attachments can be added.

Once you have an XCTActivity-conforming object: • Create a new XCTAttachment with one of the initializers provided. • Optionally customize the attachment’s lifetime, name and userInfo properties. • Add the attachment to the activity with -[XCTActivity addAttachment:].

  
    - (void)testFoo
    {
        // ...
        NSString *logs = ...
        XCTAttachment *attachment = [XCTAttachment attachmentWithString:logs];
        attachment.name = @"Build logs";
        [self addAttachment:attachment];
    }

    - (void)testNestedFoo
    {
        // ...
        [XCTContext runActivityNamed:@"Collect logs" block:^(id<XCTActivity> activity){
            NSString *logs = ...
            XCTAttachment *attachment = [XCTAttachment attachmentWithString:logs];
            attachment.name = @"Build logs";
            [activity addAttachment:attachment];
        }];
    }
  

Attachments have the default lifetime of .deleteOnSuccess, which means they are deleted when their test passes. This ensures attachments are only kept when test fails. To override this behavior, change the value of the lifetime property to .keepAlways before adding it to an activity.

  
     - (void)testImportantAttachment
     {
         XCTAttachment *attachment = ...
         attachment.lifetime = XCTAttachmentLifetimeKeepAlways;
         [self addAttachment:attachment];
     }
  

See also Apple’s documentation

Implementations

impl XCTAttachment

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

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

pub unsafe fn initWithUniformTypeIdentifier_name_payload_userInfo( this: Allocated<Self>, identifier: Option<&NSString>, name: Option<&NSString>, payload: Option<&NSData>, user_info: Option<&NSDictionary>, ) -> Retained<Self>

Safety

user_info generic should be of the correct type.

pub unsafe fn attachmentWithUniformTypeIdentifier_name_payload_userInfo( identifier: Option<&NSString>, name: Option<&NSString>, payload: Option<&NSData>, user_info: Option<&NSDictionary>, ) -> Retained<Self>

Safety

user_info generic should be of the correct type.

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

Uniform Type Identifier of the payload data. Examples: “public.png”, “public.jpeg”, “public.plain-text”, “public.data”, “com.apple.xml-property-list”.

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

Attachment name.

pub fn setName(&self, name: Option<&NSString>)

Setter for name.

This is copied when set.

pub fn userInfo(&self) -> Option<Retained<NSDictionary>>

Container for additional metadata, such as pixel density with images.

pub unsafe fn setUserInfo(&self, user_info: Option<&NSDictionary>)

Setter for userInfo.

This is copied when set.

Safety

user_info generic should be of the correct type.

pub fn lifetime(&self) -> XCTAttachmentLifetime

pub fn setLifetime(&self, lifetime: XCTAttachmentLifetime)

Setter for lifetime.

impl XCTAttachment

ConvenienceInitializers.

pub fn attachmentWithData(payload: &NSData) -> Retained<Self>

Creates a new data attachment (type “public.data”) with the specified payload.

pub fn attachmentWithData_uniformTypeIdentifier( payload: &NSData, identifier: &NSString, ) -> Retained<Self>

Creates a new attachment with the specified payload and type.

pub fn attachmentWithString(string: &NSString) -> Retained<Self>

Creates a new plain UTF-8 encoded text attachment (type “public.plain-text”) with the specified string.

pub unsafe fn attachmentWithArchivableObject( object: &ProtocolObject<dyn NSSecureCoding>, ) -> Retained<Self>

Creates an attachment with an object that can be encoded with NSSecureCoding. Defaults to type “public.data”.

Safety

object should be of the correct type.

pub unsafe fn attachmentWithArchivableObject_uniformTypeIdentifier( object: &ProtocolObject<dyn NSSecureCoding>, identifier: &NSString, ) -> Retained<Self>

Creates an attachment with an object that can be encoded with NSSecureCoding and type.

Safety

object should be of the correct type.

pub unsafe fn attachmentWithPlistObject(object: &AnyObject) -> Retained<Self>

Creates an attachment with an object that can be encoded into an XML property list.

Safety

object should be of the correct type.

pub fn attachmentWithContentsOfFileAtURL(url: &NSURL) -> Retained<Self>

Creates an attachment with an existing file on disk. Attachment’s uniform type identifier is inferred from the file extension. If no type can be inferred from the extension, fallback is “public.data”.

Note: Only works for files, not directories.

pub fn attachmentWithContentsOfFileAtURL_uniformTypeIdentifier( url: &NSURL, identifier: &NSString, ) -> Retained<Self>

Creates an attachment with an existing file on disk and type.

Note: Only works for files, not directories.

pub fn attachmentWithCompressedContentsOfDirectoryAtURL( url: &NSURL, ) -> Retained<Self>

Creates an attachment with an existing directory on disk. Automatically zips the directory, the content type is “public.zip-archive”.

pub fn attachmentWithImage(image: &NSImage) -> Retained<Self>

Available on crate feature objc2-app-kit and macOS only.

pub fn attachmentWithImage_quality( image: &NSImage, quality: XCTImageQuality, ) -> Retained<Self>

Available on crate feature objc2-app-kit and macOS only.

impl XCTAttachment

XCUIScreenshot_ConvenienceInitializers.

pub fn attachmentWithScreenshot(screenshot: &XCUIScreenshot) -> Retained<Self>

Available on crate feature objc2-xc-ui-automation only.

Creates an attachment with a screenshot and the specified quality.

pub fn attachmentWithScreenshot_quality( screenshot: &XCUIScreenshot, quality: XCTImageQuality, ) -> Retained<Self>

Available on crate feature objc2-xc-ui-automation only.

Creates an attachment with a screenshot and the specified quality.

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 XCTAttachment

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for XCTAttachment

fn as_ref(&self) -> &NSObject

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

impl AsRef<XCTAttachment> for XCTAttachment

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for XCTAttachment

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for XCTAttachment

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for XCTAttachment

const NAME: &'static str = "XCTAttachment"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for XCTAttachment

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for XCTAttachment

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 XCTAttachment

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for XCTAttachment

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for XCTAttachment

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 NSSecureCoding for XCTAttachment

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for XCTAttachment

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 XCTAttachment

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

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

impl DowncastTarget for XCTAttachment

impl Eq for XCTAttachment