Struct NSConnection

Source

pub struct NSConnection { /* private fields */ }

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSConnection only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSConnection

Source

pub fn statistics(&self) -> Retained<NSDictionary<NSString, NSNumber>>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSDictionary and NSString and NSValue only.

Source

pub fn allConnections() -> Retained<NSArray<NSConnection>>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSArray only.

Source

pub fn defaultConnection() -> Retained<NSConnection>

👎Deprecated

Source

pub fn connectionWithRegisteredName_host( name: &NSString, host_name: Option<&NSString>, ) -> Option<Retained<Self>>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSString only.

Source

pub fn connectionWithRegisteredName_host_usingNameServer( name: &NSString, host_name: Option<&NSString>, server: &NSPortNameServer, ) -> Option<Retained<Self>>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSPortNameServer and NSString only.

Source

pub fn rootProxyForConnectionWithRegisteredName_host( name: &NSString, host_name: Option<&NSString>, ) -> Option<Retained<NSDistantObject>>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSDistantObject and NSProxy and NSString only.

Source

pub fn rootProxyForConnectionWithRegisteredName_host_usingNameServer( name: &NSString, host_name: Option<&NSString>, server: &NSPortNameServer, ) -> Option<Retained<NSDistantObject>>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSDistantObject and NSPortNameServer and NSProxy and NSString only.

Source

pub unsafe fn serviceConnectionWithName_rootObject_usingNameServer( name: &NSString, root: &AnyObject, server: &NSPortNameServer, ) -> Option<Retained<Self>>

Available on crate features NSPortNameServer and NSString only.

§Safety

root should be of the correct type.

Source

pub unsafe fn serviceConnectionWithName_rootObject( name: &NSString, root: &AnyObject, ) -> Option<Retained<Self>>

Available on crate feature NSString only.

§Safety

root should be of the correct type.

Source

pub fn requestTimeout(&self) -> NSTimeInterval

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSDate only.

Source

pub fn setRequestTimeout(&self, request_timeout: NSTimeInterval)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSDate only.

Setter for requestTimeout.

Source

pub fn replyTimeout(&self) -> NSTimeInterval

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSDate only.

Source

pub fn setReplyTimeout(&self, reply_timeout: NSTimeInterval)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSDate only.

Setter for replyTimeout.

Source

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

👎Deprecated: Use NSXPCConnection instead

Source

pub unsafe fn setRootObject(&self, root_object: Option<&AnyObject>)

👎Deprecated: Use NSXPCConnection instead

Setter for rootObject.

§Safety

root_object should be of the correct type.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSConnectionDelegate>>>

👎Deprecated: Use NSXPCConnection instead

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSConnectionDelegate>>, )

👎Deprecated: Use NSXPCConnection instead

Setter for delegate.

§Safety

This is unretained, you must ensure the object is kept alive while in use.

Source

pub fn independentConversationQueueing(&self) -> bool

👎Deprecated: Use NSXPCConnection instead

Source

pub fn setIndependentConversationQueueing( &self, independent_conversation_queueing: bool, )

👎Deprecated: Use NSXPCConnection instead

Setter for independentConversationQueueing.

Source

pub fn isValid(&self) -> bool

👎Deprecated: Use NSXPCConnection instead

Source

pub fn rootProxy(&self) -> Retained<NSDistantObject>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSDistantObject and NSProxy only.

Source

pub fn invalidate(&self)

👎Deprecated: Use NSXPCConnection instead

Source

pub fn addRequestMode(&self, rmode: &NSString)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSString only.

Source

pub fn removeRequestMode(&self, rmode: &NSString)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSString only.

Source

pub fn requestModes(&self) -> Retained<NSArray<NSString>>

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSArray and NSString only.

Source

pub fn registerName(&self, name: Option<&NSString>) -> bool

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSString only.

Source

pub fn registerName_withNameServer( &self, name: Option<&NSString>, server: &NSPortNameServer, ) -> bool

👎Deprecated: Use NSXPCConnection instead

Available on crate features NSPortNameServer and NSString only.

Source

pub fn connectionWithReceivePort_sendPort( receive_port: Option<&NSPort>, send_port: Option<&NSPort>, ) -> Option<Retained<Self>>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSPort only.

Source

pub fn currentConversation() -> Option<Retained<AnyObject>>

👎Deprecated: Use NSXPCConnection instead

Source

pub fn initWithReceivePort_sendPort( this: Allocated<Self>, receive_port: Option<&NSPort>, send_port: Option<&NSPort>, ) -> Option<Retained<Self>>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSPort only.

Source

pub fn sendPort(&self) -> Retained<NSPort>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSPort only.

Source

pub fn receivePort(&self) -> Retained<NSPort>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSPort only.

Source

pub fn enableMultipleThreads(&self)

👎Deprecated: Use NSXPCConnection instead

Source

pub fn multipleThreadsEnabled(&self) -> bool

👎Deprecated: Use NSXPCConnection instead

Source

pub unsafe fn addRunLoop(&self, runloop: &NSRunLoop)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSRunLoop only.

§Safety

runloop possibly has additional threading requirements.

Source

pub unsafe fn removeRunLoop(&self, runloop: &NSRunLoop)

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSRunLoop only.

§Safety

runloop possibly has additional threading requirements.

Source

pub fn runInNewThread(&self)

👎Deprecated: Use NSXPCConnection instead

Source

pub fn remoteObjects(&self) -> Retained<NSArray>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSArray only.

Source

pub fn localObjects(&self) -> Retained<NSArray>

👎Deprecated: Use NSXPCConnection instead

Available on crate feature NSArray only.

Source

pub unsafe fn dispatchWithComponents(&self, components: &NSArray)

Available on crate feature NSArray only.

§Safety

components generic should be of the correct type.

Source §

impl NSConnection

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

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