Struct NEAppRule

Source

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

Expand description

The NEAppRule class declares the programmatic interface for an object that contains the match conditions for a rule that is used to match network traffic originated by applications.

NEAppRule is used in the context of a Network Extension configuration to specify what traffic should be made available to the Network Extension.

Instances of this class are thread safe.

Implementations§

Source §

impl NEAppRule

Source

pub unsafe fn initWithSigningIdentifier( this: Allocated<Self>, signing_identifier: &NSString, ) -> Retained<Self>

Initializes a newly-allocated NEAppRule object.

Parameter signingIdentifier: The signing identifier of the executable that matches the rule.

Source

pub unsafe fn initWithSigningIdentifier_designatedRequirement( this: Allocated<Self>, signing_identifier: &NSString, designated_requirement: &NSString, ) -> Retained<Self>

Initializes a newly-allocated NEAppRule object.

Parameter signingIdentifier: The signing identifier of the executable that matches the rule.

Parameter designatedRequirement: The designated requirement of the executable that matches the rule.

Source

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

A string containing a signing identifier. If the code signature of the executable being evaluated has a signing identifier equal to this string and all other conditions of the rule match, then the rule matches.

Source

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

A string containing a designated requirement. If the code signature of the exectuable being evaluated has a designated requirement equal to this string and all other conditions of the rule match, then the rule matches. This property is required on Mac OS X.

Source

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

A string containing a file system path. If the file system path of the executable being evaluated is equal to this string and all other conditions of the rule match, then the rule matches. This property is optional.

Source

pub unsafe fn setMatchPath(&self, match_path: Option<&NSString>)

Setter for matchPath.

Source

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

An array of strings. This property is actually read-only. If the destination host of the network traffic being evaluated has a suffix equal to one of the strings in this array and all other conditions of the rule match, then the rule matches. This property is optional.

Source

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

Setter for matchDomains.

Source

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

An array of NEAppRule objects. Use this property to restrict this rule to only match network traffic that is generated by one or more “helper tool” processes that are spawned by the app that matches this rule. For example, to match network traffic generated by the “curl” command line tool when the tool is run from Terminal.app, create an NEAppRule for Terminal.app and set the app rule’s matchTools property to an array that contains an NEAppRule for the “curl” command line tool. Set this property to nil (which is the default) to match all network traffic generated by the matching app and all helper tool processes spawned by the matching app.

Source

pub unsafe fn setMatchTools(&self, match_tools: Option<&NSArray<NEAppRule>>)

Setter for matchTools.

Source §

impl NEAppRule

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