Struct GKMatchmakerViewController

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

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

Apple’s documentation

Implementations

impl GKMatchmakerViewController

pub unsafe fn matchmakerDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn GKMatchmakerViewControllerDelegate>>>

pub unsafe fn setMatchmakerDelegate( &self, matchmaker_delegate: Option<&ProtocolObject<dyn GKMatchmakerViewControllerDelegate>>, )

This is a weak property. Setter for matchmakerDelegate.

pub unsafe fn matchRequest(&self) -> Retained<GKMatchRequest>

Available on crate feature GKMatchmaker only.

pub unsafe fn isHosted(&self) -> bool

set to YES to receive hosted (eg. not peer-to-peer) match results. Will cause the controller to return an array of players instead of a match.

pub unsafe fn setHosted(&self, hosted: bool)

Setter for isHosted.

pub unsafe fn matchmakingMode(&self) -> GKMatchmakingMode

this controls which mode of matchmaking to support in the UI (all, nearby only, automatch only, invite only). Throws an exeption if you can not set to the desired mode (due to restrictions)

pub unsafe fn setMatchmakingMode(&self, matchmaking_mode: GKMatchmakingMode)

Setter for matchmakingMode.

pub unsafe fn canStartWithMinimumPlayers(&self) -> bool

A BOOL value to allow the GKMatchMakerViewController to return control to the game once the minimum number of players are connected. By default the value is NO, and the multiplayer match can only proceed after all players are connected. If the value is set to YES, then once the number of connected players is greater than or equal to minPlayers of the match request, matchmakerViewController:didFindMatch: will be called and the game can get the match instance, and update the game scene accordingly. The remaining players wil continue to connect.

pub unsafe fn setCanStartWithMinimumPlayers( &self, can_start_with_minimum_players: bool, )

Setter for canStartWithMinimumPlayers.

pub unsafe fn initWithMatchRequest( this: Allocated<Self>, request: &GKMatchRequest, ) -> Option<Retained<Self>>

Available on crate feature GKMatchmaker only.

Initialize with a matchmaking request, allowing the user to send invites and/or start matchmaking

pub unsafe fn initWithInvite( this: Allocated<Self>, invite: &GKInvite, ) -> Option<Retained<Self>>

Available on crate feature GKMatchmaker only.

Initialize with an accepted invite, allowing the user to see the status of other invited players and get notified when the game starts

pub unsafe fn addPlayersToMatch(&self, match: &GKMatch)

Available on crate feature GKMatch only.

Add additional players (not currently connected) to an existing peer-to-peer match. Apps should elect a single device to do this, otherwise conflicts could arise resulting in unexpected connection errors.

pub unsafe fn setHostedPlayer_didConnect( &self, player: &GKPlayer, connected: bool, )

Available on crate features GKBasePlayer and GKPlayer only.

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

👎Deprecated: No longer supported.

deprecated, set the message on the match request instead

pub unsafe fn setDefaultInvitationMessage( &self, default_invitation_message: Option<&NSString>, )

👎Deprecated: No longer supported.

Setter for defaultInvitationMessage.

impl GKMatchmakerViewController

Methods declared on superclass NSViewController.

pub unsafe fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSNibName>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

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

impl GKMatchmakerViewController

Methods declared on superclass NSResponder.

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

impl GKMatchmakerViewController

Methods declared on superclass NSObject.

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

impl GKMatchmakerViewController

Obsoleted.

pub unsafe fn setHostedPlayer_connected( &self, player_id: &NSString, connected: bool, )

👎Deprecated

• This method is obsolete. It will never be invoked and its implementation does nothing**

pub unsafe fn setHostedPlayerReady(&self, player_id: &NSString)

👎Deprecated

• This method is obsolete. It will never be invoked and its implementation does nothing**

Methods from Deref<Target = NSViewController>

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

pub unsafe fn nibBundle(&self) -> Option<Retained<NSBundle>>

pub unsafe fn representedObject(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setRepresentedObject( &self, represented_object: Option<&AnyObject>, )

Setter for representedObject.

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

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

Setter for title.

pub unsafe fn loadView(&self)

pub unsafe fn loadViewIfNeeded(&self)

pub unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

pub unsafe fn commitEditing(&self) -> bool

pub unsafe fn discardEditing(&self)

pub unsafe fn viewDidLoad(&self)

pub unsafe fn isViewLoaded(&self) -> bool

pub unsafe fn viewWillAppear(&self)

pub unsafe fn viewDidAppear(&self)

pub unsafe fn viewWillDisappear(&self)

pub unsafe fn viewDidDisappear(&self)

pub unsafe fn preferredContentSize(&self) -> CGSize

pub unsafe fn setPreferredContentSize(&self, preferred_content_size: CGSize)

Setter for preferredContentSize.

pub unsafe fn updateViewConstraints(&self)

pub unsafe fn viewWillLayout(&self)

pub unsafe fn viewDidLayout(&self)

pub unsafe fn presentViewController_animator( &self, view_controller: &NSViewController, animator: &ProtocolObject<dyn NSViewControllerPresentationAnimator>, )

pub unsafe fn dismissViewController(&self, view_controller: &NSViewController)

pub unsafe fn dismissController(&self, sender: Option<&AnyObject>)

pub unsafe fn presentedViewControllers( &self, ) -> Option<Retained<NSArray<NSViewController>>>

pub unsafe fn presentingViewController( &self, ) -> Option<Retained<NSViewController>>

pub unsafe fn presentViewControllerAsSheet( &self, view_controller: &NSViewController, )

pub unsafe fn presentViewControllerAsModalWindow( &self, view_controller: &NSViewController, )

pub unsafe fn parentViewController(&self) -> Option<Retained<NSViewController>>

pub unsafe fn childViewControllers(&self) -> Retained<NSArray<NSViewController>>

pub unsafe fn setChildViewControllers( &self, child_view_controllers: &NSArray<NSViewController>, )

Setter for childViewControllers.

pub unsafe fn addChildViewController( &self, child_view_controller: &NSViewController, )

pub unsafe fn removeFromParentViewController(&self)

pub unsafe fn insertChildViewController_atIndex( &self, child_view_controller: &NSViewController, index: isize, )

pub unsafe fn removeChildViewControllerAtIndex(&self, index: isize)

pub unsafe fn preferredContentSizeDidChangeForViewController( &self, view_controller: &NSViewController, )

pub unsafe fn viewWillTransitionToSize(&self, new_size: CGSize)

pub unsafe fn extensionContext(&self) -> Option<Retained<NSExtensionContext>>

pub unsafe fn preferredScreenOrigin(&self) -> CGPoint

pub unsafe fn setPreferredScreenOrigin(&self, preferred_screen_origin: CGPoint)

Setter for preferredScreenOrigin.

pub unsafe fn preferredMinimumSize(&self) -> CGSize

pub unsafe fn preferredMaximumSize(&self) -> CGSize

Methods from Deref<Target = NSResponder>

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

pub unsafe fn noResponderFor(&self, event_selector: Sel)

pub unsafe fn acceptsFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn flushBufferedKeyEvents(&self)

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

pub unsafe fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn presentError_modalForWindow_delegate_didPresentSelector_contextInfo( &self, error: &NSError, window: &NSWindow, delegate: Option<&AnyObject>, did_present_selector: Option<Sel>, context_info: *mut c_void, )

pub unsafe fn presentError(&self, error: &NSError) -> bool

pub unsafe fn willPresentError(&self, error: &NSError) -> Retained<NSError>

pub unsafe fn performTextFinderAction(&self, sender: Option<&AnyObject>)

pub unsafe fn newWindowForTab(&self, sender: Option<&AnyObject>)

pub unsafe fn showWritingTools(&self, sender: Option<&AnyObject>)

pub unsafe fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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 GKMatchmakerViewController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKMatchmakerViewController> for GKMatchmakerViewController

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GKMatchmakerViewController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for GKMatchmakerViewController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSViewController> for GKMatchmakerViewController

fn as_ref(&self) -> &NSViewController

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

impl Borrow<AnyObject> for GKMatchmakerViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKMatchmakerViewController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for GKMatchmakerViewController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSViewController> for GKMatchmakerViewController

fn borrow(&self) -> &NSViewController

Immutably borrows from an owned value.

impl ClassType for GKMatchmakerViewController

const NAME: &'static str = "GKMatchmakerViewController"

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

type Super = NSViewController

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for GKMatchmakerViewController

type Target = NSViewController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GKMatchmakerViewController

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 GKMatchmakerViewController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for GKMatchmakerViewController

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSEditor for GKMatchmakerViewController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

unsafe fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

unsafe fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for GKMatchmakerViewController

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 NSSeguePerforming for GKMatchmakerViewController

unsafe fn prepareForSegue_sender( &self, segue: &NSStoryboardSegue, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

impl NSUserInterfaceItemIdentification for GKMatchmakerViewController

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

where Self: Sized + Message,

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for GKMatchmakerViewController

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 GKMatchmakerViewController

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

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

impl DowncastTarget for GKMatchmakerViewController

impl Eq for GKMatchmakerViewController

impl GKViewController for GKMatchmakerViewController