Struct NEFilterControlVerdict

Source

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

Expand description

The NEFilterControlVerdict declares the programmatic interface of an object that is the verdict for a new flow of network data by the control provider.

NEFilterControlVerdict is part of NetworkExtension.framework

Implementations§

Source §

impl NEFilterControlVerdict

Source

pub unsafe fn allowVerdictWithUpdateRules( update_rules: bool, ) -> Retained<NEFilterControlVerdict>

This class method returns a verdict indicating that the flow should be allowed to go through, and also tell the data provider whether to update its rules or not.

Parameter updateRules: YES if the control provider has updated the rules and wants to communicate that to the data provider

Returns: The NEFilterControlVerdict object.

Source

pub unsafe fn dropVerdictWithUpdateRules( update_rules: bool, ) -> Retained<NEFilterControlVerdict>

This class method returns a verdict indicating that the flow should be dropped, and also tell the data provider whether to update its rules or not.

Parameter updateRules: YES if the control provider has updated the rules and wants to communicate that to the data provider

Returns: The NEFilterControlVerdict object.

Source

pub unsafe fn updateRules() -> Retained<NEFilterControlVerdict>

This class method returns a verdict indicating that the flow should be handled by the data provider, and the rules needed by the data provider have been set.

Returns: The NEFilterControlVerdict object.

Source §

impl NEFilterControlVerdict

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 = NEFilterNewFlowVerdict>§

Source

pub unsafe fn statisticsReportFrequency(&self) -> NEFilterReportFrequency

The frequency at which the data provider’s -[NEFilterProvider handleReport:] method is called with a NEFilterReport instance with an event of NEFilterReportEventFlowStatistics. The default value is NEFilterReportFrequencyNone, so by default no statistics are reported.

Source

pub unsafe fn setStatisticsReportFrequency( &self, statistics_report_frequency: NEFilterReportFrequency, )

Setter for statisticsReportFrequency.

Methods from Deref<Target = NEFilterVerdict>§

Source

pub unsafe fn shouldReport(&self) -> bool

Whether or not to send a report to the control provider’s -[NEFilterProvider handleReport:] method when processing this verdict and when the flow is closed. Since the data provider does not need to wait for a response from the control provider before continuing to process the flow, this is a more efficient way to report a flow to the control provider than returning a “need rules” verdict. If the verdict originates in the control provider, this property has no effect. This property applies when the action taken upon a flow is allow, deny, remediate, or filterData (filterData for new flows only). Setting this flag on a verdict for a socket flow will also cause the data provider’s -[NEFilterProvider handleReport:] method to be called when the flow is closed.

Source

pub unsafe fn setShouldReport(&self, should_report: bool)

Setter for shouldReport.

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