Struct NERelayManager

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

The NERelayManager class declares the programmatic interface for an object that manages relay configurations.

NERelayManager declares methods and properties for configuring and controlling relay settings on the system.

Instances of this class are thread safe.

See also Apple’s documentation

Implementations

impl NERelayManager

pub unsafe fn sharedManager() -> Retained<NERelayManager>

Returns: The singleton NERelayManager object for the calling process.

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

Available on crate feature block2 only.

This function loads the current relay configuration from the caller’s relay preferences.

Parameter completionHandler: A block that will be called when the load operation is completed. The NSError passed to this block will be nil if the load operation succeeded, non-nil otherwise.

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

Available on crate feature block2 only.

This function removes the relay configuration from the caller’s relay preferences. If the relay is enabled, the relay becomes disabled.

Parameter completionHandler: A block that will be called when the remove operation is completed. The NSError passed to this block will be nil if the remove operation succeeded, non-nil otherwise.

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

Available on crate feature block2 only.

This function saves the relay configuration in the caller’s relay preferences. If the relay are enabled, they will become active.

Parameter completionHandler: A block that will be called when the save operation is completed. The NSError passed to this block will be nil if the save operation succeeded, non-nil otherwise.

pub unsafe fn getLastClientErrors_completionHandler( &self, seconds: NSTimeInterval, completion_handler: &DynBlock<dyn Fn(*mut NSArray<NSError>)>, )

Available on crate feature block2 only.

This function will get errors that the client detected while using this relay configuration within the specified time period. Errors will be from the NERelayClientErrorDomain and the NERelayManagerClientErrorNone value will be set for successful connections.

Parameter seconds: A NSTimeInterval that specifies how many seconds to report errors for. The maximum supported value is 24 hours and any larger values will be automatically reduced to 24 hours.

Parameter completionHandler: A block that will be called when once the errors have been collected. The NSArray will contain a list of NERelayManagerClientError values detected within the last number of seconds as specified by the “seconds” parameter. The values will be ordered from the error most recently detected to the oldest. The error value of NERelayManagerClientErrorNone indicates the last successful use of the relay without error. The NSArray will be empty if there are no values detected within the specified time period or nil if there was a problem in retrieving the errors.

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

A string containing a description of the relay.

pub unsafe fn setLocalizedDescription( &self, localized_description: Option<&NSString>, )

Setter for localizedDescription.

pub unsafe fn isEnabled(&self) -> bool

Toggles the enabled status of the relay.

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn isUIToggleEnabled(&self) -> bool

Determines if the user will have the ability to enable and disable the relay

pub unsafe fn setUIToggleEnabled(&self, ui_toggle_enabled: bool)

Setter for isUIToggleEnabled.

pub unsafe fn relays(&self) -> Option<Retained<NSArray<NERelay>>>

An array of relay configurations describing one or more relay hops.

pub unsafe fn setRelays(&self, relays: Option<&NSArray<NERelay>>)

Setter for relays.

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

An array of strings containing domain names. If this property is non-nil, the relay will be used to access hosts within the specified domains. If this and the match FQDNs property is nil, the relay will be used for all domains.

pub unsafe fn setMatchDomains(&self, match_domains: Option<&NSArray<NSString>>)

Setter for matchDomains.

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

An array of strings containing Fully Qualified Domain Names (FQDNs). If this property is non-nil, the relay will be used to access the specified hosts. If this and the matchDomains property is nil, the relay will be used for all domains.

pub unsafe fn setMatchFQDNs(&self, match_fqd_ns: Option<&NSArray<NSString>>)

Setter for matchFQDNs.

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

An array of strings containing domain names. If the destination host name of a connection shares a suffix with one of these strings then the relay will not be used.

pub unsafe fn setExcludedDomains( &self, excluded_domains: Option<&NSArray<NSString>>, )

Setter for excludedDomains.

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

An array of strings containing Fully Qualified Domain Names (FQDNs). If the destination host matches one of these strings then the relay will not be used. An excluded FQDN takes priority over the matchDomain property. This means the relay will not be used if the hostname matches an FQDN in this array even if the matchDomains contains a domain that would have been considered a match.

pub unsafe fn setExcludedFQDNs( &self, excluded_fqd_ns: Option<&NSArray<NSString>>, )

Setter for excludedFQDNs.

pub unsafe fn onDemandRules(&self) -> Option<Retained<NSArray<NEOnDemandRule>>>

An array of NEOnDemandRule objects. If nil, the associated relay will always apply. If non-nil, the array describes the networks on which the relay should be used or not.

pub unsafe fn setOnDemandRules( &self, on_demand_rules: Option<&NSArray<NEOnDemandRule>>, )

Setter for onDemandRules.

pub unsafe fn loadAllManagersFromPreferencesWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(NonNull<NSArray<NERelayManager>>, *mut NSError)>, )

Available on crate feature block2 only.

This function asynchronously reads all of the NERelay configurations created by the calling app that have previously been saved to disk and returns them as NERelayManager objects.

Parameter completionHandler: A block that takes an array NERelayManager objects. The array passed to the block may be empty if no NERelay configurations were successfully read from the disk. The NSError passed to this block will be nil if the load operation succeeded, non-nil otherwise.

impl NERelayManager

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 NERelayManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NERelayManager> for NERelayManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NERelayManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NERelayManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NERelayManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NERelayManager

const NAME: &'static str = "NERelayManager"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NERelayManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NERelayManager

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 NERelayManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NERelayManager

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 PartialEq for NERelayManager

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 NERelayManager

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

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

impl DowncastTarget for NERelayManager

impl Eq for NERelayManager