Struct NETunnelProviderManager

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

The NETunnelProviderManager class declares the programmatic interface for an object that is used to configure and control network tunnels provided by NETunnelProviders.

Instances of this class are thread safe.

See also Apple’s documentation

Implementations

impl NETunnelProviderManager

pub unsafe fn loadAllFromPreferencesWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(*mut NSArray<NETunnelProviderManager>, *mut NSError)>, )

Available on crate feature block2 only.

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

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

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

Create a NETunnelProviderManager instance that is used to manage a per-app VPN configuration.

pub unsafe fn copyAppRules(&self) -> Option<Retained<NSArray<NEAppRule>>>

This function returns an array of NEAppRule objects.

pub unsafe fn routingMethod(&self) -> NETunnelProviderRoutingMethod

The method by which network traffic is routed to the tunnel. The default is NETunnelProviderRoutingMethodDestinationIP.

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

An array of domain strings. Only applies to per-app VPN configurations. When the per-app VPN is enabled and the user navigates in Safari to a web site within one of these domains, the web site network traffic is routed through the per-app VPN.

pub unsafe fn setSafariDomains(&self, safari_domains: &NSArray<NSString>)

Setter for safariDomains.

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

An array of domain strings. Only applies to per-app VPN configurations. When the per-app VPN is enabled, connections from the Mail app to mail servers within one of these domains are routed through the per-app VPN.

pub unsafe fn setMailDomains(&self, mail_domains: &NSArray<NSString>)

Setter for mailDomains.

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

An array of domain strings. Only applies to per-app VPN configurations. When the per-app VPN is enabled, connections from the Calendar app to calendar servers within one of these domains are routed through the per-app VPN.

pub unsafe fn setCalendarDomains(&self, calendar_domains: &NSArray<NSString>)

Setter for calendarDomains.

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

An array of domain strings. Only applies to per-app VPN configurations. When the per-app VPN is enabled, connections from the Contacts app to contacts servers within one of these domains are routed through the per-app VPN.

pub unsafe fn setContactsDomains(&self, contacts_domains: &NSArray<NSString>)

Setter for contactsDomains.

pub unsafe fn appRules(&self) -> Retained<NSArray<NEAppRule>>

pub unsafe fn setAppRules(&self, app_rules: &NSArray<NEAppRule>)

Setter for appRules.

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

per-app VPN.

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

Setter for excludedDomains.

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

pub unsafe fn setAssociatedDomains( &self, associated_domains: &NSArray<NSString>, )

Setter for associatedDomains.

impl NETunnelProviderManager

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NEVPNManager>

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

Available on crate feature block2 only.

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

Parameter completionHandler: A block that will be called on the main thread 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: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

This function removes the VPN configuration from the caller’s VPN preferences. If the VPN is enabled, has VPN On Demand enabled, and has VPN On Demand rules, the VPN is disabled and the VPN On Demand rules are de-activated.

Parameter completionHandler: A block that will be called on the main thread 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: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

This function saves the VPN configuration in the caller’s VPN preferences. If the VPN is enabled, has VPN On Demand enabled, and has VPN On Demand rules, the VPN On Demand rules are activated.

Parameter completionHandler: A block that will be called on the main thread 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 setAuthorization(&self, authorization: AuthorizationRef)

Available on crate feature objc2-security only.

This function sets an authorization object that can be used to obtain the authorization rights necessary to modify the system VPN configuration.

Parameter authorization: The AuthorizationRef to use to obtain rights.

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

An array of NEOnDemandRule objects.

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

Setter for onDemandRules.

pub unsafe fn isOnDemandEnabled(&self) -> bool

Toggles VPN On Demand.

pub unsafe fn setOnDemandEnabled(&self, on_demand_enabled: bool)

Setter for isOnDemandEnabled.

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

A string containing a description of the VPN.

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

Setter for localizedDescription.

pub unsafe fn protocol(&self) -> Option<Retained<NEVPNProtocol>>

👎Deprecated

An NEVPNProtocol object containing the protocol-specific portion of the VPN configuration.

pub unsafe fn setProtocol(&self, protocol: Option<&NEVPNProtocol>)

👎Deprecated

Setter for protocol.

pub unsafe fn protocolConfiguration(&self) -> Option<Retained<NEVPNProtocol>>

An NEVPNProtocol object containing the protocol-specific portion of the VPN configuration.

pub unsafe fn setProtocolConfiguration( &self, protocol_configuration: Option<&NEVPNProtocol>, )

Setter for protocolConfiguration.

pub unsafe fn connection(&self) -> Retained<NEVPNConnection>

The NEVPNConnection object used for controlling the VPN tunnel.

pub unsafe fn isEnabled(&self) -> bool

Toggles the enabled status of the VPN. Setting this property will disable VPN configurations of other apps. This property will be set to NO when other VPN configurations are enabled.

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

Setter for isEnabled.

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 NETunnelProviderManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NETunnelProviderManager> for NEAppProxyProviderManager

fn as_ref(&self) -> &NETunnelProviderManager

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

impl AsRef<NETunnelProviderManager> for NETunnelProviderManager

fn as_ref(&self) -> &Self

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

impl AsRef<NEVPNManager> for NETunnelProviderManager

fn as_ref(&self) -> &NEVPNManager

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

impl AsRef<NSObject> for NETunnelProviderManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NETunnelProviderManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NETunnelProviderManager> for NEAppProxyProviderManager

fn borrow(&self) -> &NETunnelProviderManager

Immutably borrows from an owned value.

impl Borrow<NEVPNManager> for NETunnelProviderManager

fn borrow(&self) -> &NEVPNManager

Immutably borrows from an owned value.

impl Borrow<NSObject> for NETunnelProviderManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NETunnelProviderManager

const NAME: &'static str = "NETunnelProviderManager"

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

type Super = NEVPNManager

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NETunnelProviderManager

type Target = NEVPNManager

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NETunnelProviderManager

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 NETunnelProviderManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NETunnelProviderManager

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 NETunnelProviderManager

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 NETunnelProviderManager

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

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

impl DowncastTarget for NETunnelProviderManager

impl Eq for NETunnelProviderManager