Struct NWTLSParameters

Source

pub struct NWTLSParameters { /* private fields */ }

👎Deprecated: Use sec_protocol_options_t in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

Expand description

DEPRECATION NOTICE

NW object wrappers are hidden in Swift 6. To continue accessing them, you can prepend double underscores to the symbol name.

Implementations§

Source §

impl NWTLSParameters

Source

pub unsafe fn TLSSessionID(&self) -> Option<Retained<NSData>>

👎Deprecated: Use sec_protocol_options_set_tls_resumption_enabled in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

The session ID for the associated connection, used for TLS session resumption. This property is optional when using TLS.

Source

pub unsafe fn setTLSSessionID(&self, tls_session_id: Option<&NSData>)

👎Deprecated: Use sec_protocol_options_set_tls_resumption_enabled in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

Setter for TLSSessionID.

This is copied when set.

Source

pub unsafe fn SSLCipherSuites(&self) -> Option<Retained<NSSet<NSNumber>>>

👎Deprecated: Use sec_protocol_options_append_tls_ciphersuite in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

The set of allowed cipher suites, as defined in <Security /CipherSuite.h>. If set to nil, the default cipher suites will be used.

Source

pub unsafe fn setSSLCipherSuites( &self, ssl_cipher_suites: Option<&NSSet<NSNumber>>, )

👎Deprecated: Use sec_protocol_options_append_tls_ciphersuite in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

Setter for SSLCipherSuites.

This is copied when set.

Source

pub unsafe fn minimumSSLProtocolVersion(&self) -> NSUInteger

👎Deprecated: Use sec_protocol_options_set_min_tls_protocol_version in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

The minimum allowed SSLProtocol value. as defined in <Security /SecureTransport.h>. If set, the SSL handshake will not accept any protocol version older than the minimum.

Source

pub unsafe fn setMinimumSSLProtocolVersion( &self, minimum_ssl_protocol_version: NSUInteger, )

👎Deprecated: Use sec_protocol_options_set_min_tls_protocol_version in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

Setter for minimumSSLProtocolVersion.

Source

pub unsafe fn maximumSSLProtocolVersion(&self) -> NSUInteger

👎Deprecated: Use sec_protocol_options_set_max_tls_protocol_version in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

The maximum allowed SSLProtocol value. as defined in <Security /SecureTransport.h>. If set, the SSL handshake will not accept any protocol version newer than the maximum. This property should be used with caution, since it may limit the use of preferred SSL protocols.

Source

pub unsafe fn setMaximumSSLProtocolVersion( &self, maximum_ssl_protocol_version: NSUInteger, )

👎Deprecated: Use sec_protocol_options_set_max_tls_protocol_version in Security framework instead, see deprecation notice in <NetworkExtension/NWTLSParameters.h>

Setter for maximumSSLProtocolVersion.

Source §

impl NWTLSParameters

Methods declared on superclass NSObject.

Source

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

Source

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