Struct CLSScoreItem

Source

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

Available on crate features CLSActivityItem and CLSObject and CLSScoreItem only.

Expand description

CLSScoreItem represents user generated score information.

Implementations§

Source §

impl CLSScoreItem

Source

pub unsafe fn score(&self) -> c_double

Score out of maxScore. Should be between zero and maxScore[0.0,maxScore].

Source

pub unsafe fn setScore(&self, score: c_double)

Setter for score.

Source

pub unsafe fn maxScore(&self) -> c_double

Total score possible.

Must be greater than zero.

Source

pub unsafe fn setMaxScore(&self, max_score: c_double)

Setter for maxScore.

Source

pub unsafe fn initWithIdentifier_title_score_maxScore( this: Allocated<Self>, identifier: &NSString, title: &NSString, score: c_double, max_score: c_double, ) -> Retained<Self>

Create a score item with identifiers, title, score and maximum score.

Parameter identifier: An identifier that is unique within activity.

Parameter title: Title of score. Ex _Biology-_Cellular Division Quiz

Parameter score: The score the user received.

Parameter maxScore: The maximum score possible.

Source §

impl CLSScoreItem

Methods declared on superclass CLSActivityItem.

Source

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

Source

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

Methods from Deref<Target = CLSActivityItem>§

Source

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

Title of what this ActivityItem represents.

This will be the title associated with the activity item in the generated progress report.

Source

pub unsafe fn setTitle(&self, title: &NSString)

Setter for title.

Source

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

An identifier that is unique within its owning activity

The identifier can be used to look up existing activityItems in a given activity.

Methods from Deref<Target = CLSObject>§

Source

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

The date this object was created.

Source

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

The date this object was last modified.

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