Struct CLSActivity

#[repr(C)]
pub struct CLSActivity { /* private fields */ }

Available on crate features CLSActivity and CLSObject only.

CLSActivity represents user generated activity data for a given context.

CLSActivity has three major components.

(1) Progress, used to measure the amount of activity a user generates as a percentage. (2) Duration, used to measure the length of time a user spent on this activity. Use -startand -stopmethods. (3) Activity Items, used to gather information about the activity generated by a user.

See also Apple’s documentation

Implementations

impl CLSActivity

pub unsafe fn progress(&self) -> c_double

Current progress as a decimal representation of a percentage.

Should be [0.0, 1.0].

pub unsafe fn setProgress(&self, progress: c_double)

Setter for progress.

pub unsafe fn duration(&self) -> NSTimeInterval

Returns the total time tracked in this activity (excluding any previous activities).

The time between calling -startand -stop.

pub unsafe fn primaryActivityItem(&self) -> Option<Retained<CLSActivityItem>>

Available on crate feature CLSActivityItem only.

The primary activityItem to be reported on.

This can be nil indicating progressproperty is the primary data instead of any activityItems.

pub unsafe fn setPrimaryActivityItem( &self, primary_activity_item: Option<&CLSActivityItem>, )

Available on crate feature CLSActivityItem only.

Setter for primaryActivityItem.

pub unsafe fn addProgressRangeFromStart_toEnd( &self, start: c_double, end: c_double, )

Adds progress to this activity.

The progress should be a decimal representation of the start and ending percentage [0.0, 1.0].

Parameter start: Starting percentage.

Parameter end: Ending percentage.

pub unsafe fn addAdditionalActivityItem(&self, activity_item: &CLSActivityItem)

Available on crate feature CLSActivityItem only.

Add an activity item to this CLSActivity.

pub unsafe fn additionalActivityItems( &self, ) -> Retained<NSArray<CLSActivityItem>>

Available on crate feature CLSActivityItem only.

Array of all additional activity items on this CLSActivity.

impl CLSActivity

Methods declared on superclass CLSObject.

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

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

impl CLSActivity

Activation.

pub unsafe fn isStarted(&self) -> bool

Returns whether this Activity has been started or not.

pub unsafe fn start(&self)

Start Activity.

Starts the activity (or resumes if previously stopped).

pub unsafe fn stop(&self)

Stop Activity.

Stops or pauses the activity and ends the time being tracked on it.

pub unsafe fn removeAllActivityItems(&self)

Deletes all activity items.

Convenience method to delete all activity items associated with the current activity.

Methods from Deref<Target = CLSObject>

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

The date this object was created.

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

The date this object was last modified.

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 CLSActivity

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CLSActivity> for CLSActivity

fn as_ref(&self) -> &Self

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

impl AsRef<CLSObject> for CLSActivity

fn as_ref(&self) -> &CLSObject

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

impl AsRef<NSObject> for CLSActivity

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CLSActivity

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CLSObject> for CLSActivity

fn borrow(&self) -> &CLSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CLSActivity

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CLSActivity

const NAME: &'static str = "CLSActivity"

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

type Super = CLSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CLSActivity

type Target = CLSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CLSActivity

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 CLSActivity

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CLSActivity

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 CLSActivity

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CLSActivity

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 CLSActivity

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

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

impl DowncastTarget for CLSActivity

impl Eq for CLSActivity

impl NSCoding for CLSActivity