Struct MXMetricPayload 

pub struct MXMetricPayload { /* private fields */ }

Available on crate feature MXMetricPayload only.

A wrapper class which contains a metric payload and associated properties of that payload.

MXMetricPayload encapsulates currently supported metric types that can be vended by MetricKit. MXMetric subclasses on MXMetricPayload are nullable. If an MXMetric subclass is nil, it indicates that the data is not available for this payload.

MXMetricPayload exposes a convenience function, JSONRepresentation, to convert the contents of the payload to a human readable JSON. This should be used in conjunction with other APIs that accept NSData.

An MXMetricPayload contains data that covers a 24 hour period of application usage. The properties timeStampBegin and timeStampEnd should be used to determine which time range the payload covers.

It is possible for an MXMetricPayload to cover regions of time where an application was updated, and thus had multiple different app version strings. The property latestApplicationVersion will always reflect the latest appVersion at the time the metric payload was created. Use includesMultipleApplicationVersions to determine if an application changed versions during the time range the payload covers.

See also Apple’s documentation

Implementations

impl MXMetricPayload

pub unsafe fn latestApplicationVersion(&self) -> Retained<NSString>

An NSString representation of the application version from which this payload was generated.

If the application version was changed during the aggregation of this data, this value will reflect the latest application version at the time of retrieval.

pub unsafe fn includesMultipleApplicationVersions(&self) -> bool

A bool which indicates whether or not this payload contains data from multiple application versions.

A value of YES indicates that this payload’s data reflects multiple application versions.

A value of NO indicates that this payload only reflects data from the application version specified by latestApplicationVersion.

pub unsafe fn timeStampBegin(&self) -> Retained<NSDate>

An NSDate object that indicates the time which the payload was generated.

pub unsafe fn timeStampEnd(&self) -> Retained<NSDate>

An NSDate object that indicates the time which the payload was generated.

pub unsafe fn cpuMetrics(&self) -> Option<Retained<MXCPUMetric>>

Available on crate features MXCPUMetric and MXMetric only.

An object containing CPU metrics for this application.

pub unsafe fn gpuMetrics(&self) -> Option<Retained<MXGPUMetric>>

Available on crate features MXGPUMetric and MXMetric only.

An object containing GPU metrics for this application.

pub unsafe fn cellularConditionMetrics( &self, ) -> Option<Retained<MXCellularConditionMetric>>

Available on crate features MXCellularConditionMetric and MXMetric only.

An object containing a cellular condition metrics for this application.

pub unsafe fn applicationTimeMetrics( &self, ) -> Option<Retained<MXAppRunTimeMetric>>

Available on crate features MXAppRunTimeMetric and MXMetric only.

An object containing running mode metrics for this application.

pub unsafe fn locationActivityMetrics( &self, ) -> Option<Retained<MXLocationActivityMetric>>

Available on crate features MXLocationActivityMetric and MXMetric only.

An object containing location activity metrics for this application.

pub unsafe fn networkTransferMetrics( &self, ) -> Option<Retained<MXNetworkTransferMetric>>

Available on crate features MXMetric and MXNetworkTransferMetric only.

An object containing network transfer metrics for this application.

pub unsafe fn applicationLaunchMetrics( &self, ) -> Option<Retained<MXAppLaunchMetric>>

Available on crate features MXAppLaunchMetric and MXMetric only.

An object containing launch metrics for this application.

pub unsafe fn applicationResponsivenessMetrics( &self, ) -> Option<Retained<MXAppResponsivenessMetric>>

Available on crate features MXAppResponsivenessMetric and MXMetric only.

An object containing hang metrics for this application.

pub unsafe fn diskIOMetrics(&self) -> Option<Retained<MXDiskIOMetric>>

Available on crate features MXDiskIOMetric and MXMetric only.

An object containing disk IO metrics for this application.

pub unsafe fn memoryMetrics(&self) -> Option<Retained<MXMemoryMetric>>

Available on crate features MXMemoryMetric and MXMetric only.

An object containing memory metrics for this application.

pub unsafe fn displayMetrics(&self) -> Option<Retained<MXDisplayMetric>>

Available on crate features MXDisplayMetric and MXMetric only.

An object containing display metrics for this application.

pub unsafe fn animationMetrics(&self) -> Option<Retained<MXAnimationMetric>>

Available on crate features MXAnimationMetric and MXMetric only.

An object containing animation metrics for this application.

pub unsafe fn applicationExitMetrics(&self) -> Option<Retained<MXAppExitMetric>>

Available on crate features MXAppExitMetric and MXMetric only.

An object containing exit metrics for this application.

pub unsafe fn diskSpaceUsageMetrics( &self, ) -> Option<Retained<MXDiskSpaceUsageMetric>>

Available on crate features MXDiskSpaceUsageMetric and MXMetric only.

An object containing disk space usage metrics for this application.

pub unsafe fn signpostMetrics( &self, ) -> Option<Retained<NSArray<MXSignpostMetric>>>

Available on crate features MXMetric and MXSignpostMetric only.

An array containing signpost metrics for this application.

pub unsafe fn metaData(&self) -> Option<Retained<MXMetaData>>

Available on crate feature MXMetaData only.

An object containing extra metadata for this payload.

pub unsafe fn JSONRepresentation(&self) -> Retained<NSData>

Convenience method to return a JSON representation of this payload.

Returns: An NSData object containing the JSON representation

pub unsafe fn DictionaryRepresentation(&self) -> Retained<NSDictionary>

👎Deprecated

Convenience method to return a NSDictionary representation of this payload.

Returns: An NSDictionary object containing the dictionary representation

pub unsafe fn dictionaryRepresentation(&self) -> Retained<NSDictionary>

Convenience method to return a NSDictionary representation of this payload.

Returns: An NSDictionary object containing the dictionary representation

impl MXMetricPayload

Methods declared on superclass NSObject.

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

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

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 MXMetricPayload

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MXMetricPayload> for MXMetricPayload

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MXMetricPayload

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MXMetricPayload

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MXMetricPayload

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MXMetricPayload

const NAME: &'static str = "MXMetricPayload"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MXMetricPayload

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MXMetricPayload

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 MXMetricPayload

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MXMetricPayload

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 MXMetricPayload

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for MXMetricPayload

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 MXMetricPayload

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

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

impl DowncastTarget for MXMetricPayload

impl Eq for MXMetricPayload

impl NSCoding for MXMetricPayload