Struct GKScore

Source
#[repr(C)]
pub struct GKScore { /* private fields */ }
👎Deprecated
Available on crate feature GKScore only.
Expand description

GKScore represents a score in the leaderboards.

See also Apple’s documentation

Implementations§

Source§

impl GKScore

GKChallenge. Use the following category methods to issue GKScoreChallenges and GKAchievementChallenges to an array of playerIDs. Players may not issue challenges to themselves nor to non-friends. Please see the GameKit reference documentation for further details on these methods.

Source

pub unsafe fn reportScores_withEligibleChallenges_withCompletionHandler( scores: &NSArray<GKScore>, challenges: &NSArray<GKChallenge>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated
Available on crate features GKChallenge and block2 only.

Use this alternative to reportScores:withCompletionHandler: to allow only certain specific challenges to be completed. Pass nil to avoid completing any challenges.

Source

pub unsafe fn reportLeaderboardScores_withEligibleChallenges_withCompletionHandler( scores: &NSArray<GKLeaderboardScore>, challenges: &NSArray<GKChallenge>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features GKChallenge and GKLeaderboardScore and block2 only.
Source§

impl GKScore

GKChallengeObsoleted.

Source

pub unsafe fn issueChallengeToPlayers_message( &self, player_i_ds: Option<&NSArray<NSString>>, message: Option<&NSString>, )

👎Deprecated
Available on crate feature GKChallenge only.
  • This method is obsolete. It will never be invoked and its implementation does nothing**
Source§

impl GKScore

GKChallengeUI.

Source

pub unsafe fn challengeComposeControllerWithMessage_players_completionHandler( &self, message: Option<&NSString>, players: Option<&NSArray<GKPlayer>>, completion_handler: GKChallengeComposeCompletionBlock, mtm: MainThreadMarker, ) -> Retained<NSViewController>

👎Deprecated
Available on crate feature GKChallenge and crate feature GKBasePlayer and crate feature GKPlayer and crate feature block2 and crate feature objc2-app-kit and macOS only.
Source

pub unsafe fn challengeComposeControllerWithMessage_players_completion( &self, message: Option<&NSString>, players: Option<&NSArray<GKPlayer>>, completion_handler: GKChallengeComposeHandler, mtm: MainThreadMarker, ) -> Retained<NSViewController>

Available on crate feature GKChallenge and crate feature GKBasePlayer and crate feature GKPlayer and crate feature block2 and crate feature objc2-app-kit and macOS only.
Source§

impl GKScore

GKChallengeObsoletedUI.

Source

pub unsafe fn challengeComposeControllerWithPlayers_message_completionHandler( &self, player_i_ds: Option<&NSArray<NSString>>, message: Option<&NSString>, completion_handler: GKChallengeComposeCompletionBlock, mtm: MainThreadMarker, ) -> Option<Retained<NSViewController>>

Available on crate feature GKChallenge and crate feature block2 and crate feature objc2-app-kit and macOS only.
  • This method is obsolete. Calling this method does nothing and will return nil **
Source§

impl GKScore

Source

pub unsafe fn initWithLeaderboardIdentifier( this: Allocated<Self>, identifier: &NSString, ) -> Retained<Self>

👎Deprecated

Initialize the score with the local player and current date.

Source

pub unsafe fn initWithLeaderboardIdentifier_player( this: Allocated<Self>, identifier: &NSString, player: &GKPlayer, ) -> Retained<Self>

👎Deprecated
Available on crate features GKBasePlayer and GKPlayer only.

Initialize the achievement for a specific player. Use to submit participant scores when ending a turn-based match.

Source

pub unsafe fn value(&self) -> i64

👎Deprecated

The score value as a 64bit integer.

Source

pub unsafe fn setValue(&self, value: i64)

👎Deprecated

Setter for value.

Source

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

👎Deprecated

The score formatted as a string, localized with a label

Source

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

👎Deprecated

leaderboard identifier (required)

Source

pub unsafe fn setLeaderboardIdentifier(&self, leaderboard_identifier: &NSString)

👎Deprecated
Source

pub unsafe fn context(&self) -> u64

👎Deprecated

optional additional context that allows a game to store and retrieve additional data associated with the store. Default value of zero is returned if no value is set.

Source

pub unsafe fn setContext(&self, context: u64)

👎Deprecated

Setter for context.

Source

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

👎Deprecated

The date this score was recorded. A newly initialized, unsubmitted GKScore records the current date at init time.

Source

pub unsafe fn player(&self) -> Retained<GKPlayer>

👎Deprecated
Available on crate features GKBasePlayer and GKPlayer only.

The player that recorded the score.

Source

pub unsafe fn rank(&self) -> NSInteger

👎Deprecated

The rank of the player within the leaderboard, only valid when returned from GKLeaderboard

Source

pub unsafe fn shouldSetDefaultLeaderboard(&self) -> bool

👎Deprecated

Convenience property to make the leaderboard associated with this GKScore, the default leaderboard for this player. Default value is false. If true, reporting that score will make the category this score belongs to, the default leaderboard for this user

Source

pub unsafe fn setShouldSetDefaultLeaderboard( &self, should_set_default_leaderboard: bool, )

👎Deprecated
Source

pub unsafe fn reportScores_withCompletionHandler( scores: &NSArray<GKScore>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated
Available on crate feature block2 only.

Report scores to the server. The value must be set, and date may be changed. Possible reasons for error:

  1. Value not set
  2. Local player not authenticated
  3. Communications problem
Source§

impl GKScore

Methods declared on superclass NSObject.

Source

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

Source

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

Source§

impl GKScore

Deprecated.

Source

pub unsafe fn reportScoreWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated
Available on crate feature block2 only.
Source

pub unsafe fn initWithCategory( this: Allocated<Self>, category: Option<&NSString>, ) -> Retained<Self>

👎Deprecated
Source

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

👎Deprecated
Source

pub unsafe fn setCategory(&self, category: Option<&NSString>)

👎Deprecated

Setter for category.

Source§

impl GKScore

Obsoleted.

Source

pub unsafe fn initWithLeaderboardIdentifier_forPlayer( this: Allocated<Self>, identifier: &NSString, player_id: &NSString, ) -> Option<Retained<Self>>

👎Deprecated
  • This method is obsolete. Calling this initialiser does nothing and will return nil **
Source

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

👎Deprecated
  • This property is obsolete. **

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

Trait Implementations§

Source§

impl AsRef<AnyObject> for GKScore

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKScore> for GKScore

Source§

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GKScore

Source§

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GKScore

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for GKScore

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl ClassType for GKScore

Source§

const NAME: &'static str = "GKScore"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = NSObject

The superclass of this class. Read more
Source§

type ThreadKind = <<GKScore as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.
Source§

impl Debug for GKScore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for GKScore

Source§

type Target = NSObject

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for GKScore

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for GKScore

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCoding for GKScore

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Source§

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

Source§

impl NSObjectProtocol for GKScore

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses. Read more
Source§

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl NSSecureCoding for GKScore

Source§

unsafe fn supportsSecureCoding() -> bool
where Self: Sized + ClassType,

Source§

impl PartialEq for GKScore

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for GKScore

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl DowncastTarget for GKScore

Source§

impl Eq for GKScore

Auto Trait Implementations§

§

impl !Freeze for GKScore

§

impl !RefUnwindSafe for GKScore

§

impl !Send for GKScore

§

impl !Sync for GKScore

§

impl !Unpin for GKScore

§

impl !UnwindSafe for GKScore

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T> AnyThread for T
where T: ClassType<ThreadKind = dyn AnyThread + 'a> + ?Sized,

Source§

fn alloc() -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,