Struct NERelay 

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

The NERelay class declares the programmatic interface of an object that manages the details of a relay’s configuration, such as authentication and URL details.

Instances of this class are thread safe.

See also Apple’s documentation

Implementations

impl NERelay

pub unsafe fn HTTP3RelayURL(&self) -> Option<Retained<NSURL>>

The URL of the relay accessible over HTTP/3.

pub unsafe fn setHTTP3RelayURL(&self, http3_relay_url: Option<&NSURL>)

Setter for HTTP3RelayURL.

pub unsafe fn HTTP2RelayURL(&self) -> Option<Retained<NSURL>>

The URL of the relay accessible over HTTP/2.

pub unsafe fn setHTTP2RelayURL(&self, http2_relay_url: Option<&NSURL>)

Setter for HTTP2RelayURL.

pub unsafe fn dnsOverHTTPSURL(&self) -> Option<Retained<NSURL>>

The URL of a DNS-over-HTTPS (DoH) resolver accessible via the relay.

pub unsafe fn setDnsOverHTTPSURL(&self, dns_over_httpsurl: Option<&NSURL>)

Setter for dnsOverHTTPSURL.

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

An IPv4 address prefix (such as “192.0.2.0/24”) that will be used to synthesize DNS answers for apps that use getaddrinfo() to resolve domains included in matchDomains

pub unsafe fn setSyntheticDNSAnswerIPv4Prefix( &self, synthetic_dns_answer_i_pv4_prefix: Option<&NSString>, )

Setter for syntheticDNSAnswerIPv4Prefix.

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

An IPv6 address prefix (such as “2001:DB8::/32”) that will be used to synthesize DNS answers for apps that use getaddrinfo() to resolve domains included in matchDomains

pub unsafe fn setSyntheticDNSAnswerIPv6Prefix( &self, synthetic_dns_answer_i_pv6_prefix: Option<&NSString>, )

Setter for syntheticDNSAnswerIPv6Prefix.

pub unsafe fn additionalHTTPHeaderFields( &self, ) -> Retained<NSDictionary<NSString, NSString>>

Additional HTTP header field names and values to be added to all relay requests.

pub unsafe fn setAdditionalHTTPHeaderFields( &self, additional_http_header_fields: &NSDictionary<NSString, NSString>, )

Setter for additionalHTTPHeaderFields.

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

TLS 1.3 raw public keys to use to authenticate the relay servers.

pub unsafe fn setRawPublicKeys(&self, raw_public_keys: Option<&NSArray<NSData>>)

Setter for rawPublicKeys.

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

The PKCS12 data for the relay client authentication. The value is a NSData in PKCS12 format.

pub unsafe fn setIdentityData(&self, identity_data: Option<&NSData>)

Setter for identityData.

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

The password to be used to decrypt the PKCS12 identity data.

pub unsafe fn setIdentityDataPassword( &self, identity_data_password: Option<&NSString>, )

Setter for identityDataPassword.

impl NERelay

Methods declared on superclass NSObject.

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

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

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 NERelay

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NERelay> for NERelay

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NERelay

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NERelay

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NERelay

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NERelay

const NAME: &'static str = "NERelay"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NERelay 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 CopyingHelper for NERelay

type Result = NERelay

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NERelay

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

Formats the value using the given formatter.

impl Deref for NERelay

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NERelay

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 NERelay

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NERelay

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NERelay

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 NSSecureCoding for NERelay

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NERelay

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 NERelay

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

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

impl DowncastTarget for NERelay

impl Eq for NERelay

impl NSCoding for NERelay