Struct NEFilterDataVerdict

Source

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

Expand description

The NEFilterDataVerdict class declares the programmatic interface of an object that is the verdict for a flow of network data after some of the data has been seen by the filter.

NEFilterDataVerdict is part of NetworkExtension.framework

Implementations§

Source §

impl NEFilterDataVerdict

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.

Source

pub unsafe fn allowVerdict() -> Retained<NEFilterDataVerdict>

This class method returns a verdict indicating that the flow should be allowed.

Returns: The NEFilterDataVerdict object.

Source

pub unsafe fn dropVerdict() -> Retained<NEFilterDataVerdict>

This class method returns a verdict indicating that the flow should be dropped.

Returns: The NEFilterDataVerdict object.

Source

pub unsafe fn remediateVerdictWithRemediationURLMapKey_remediationButtonTextMapKey( remediation_url_map_key: Option<&NSString>, remediation_button_text_map_key: Option<&NSString>, ) -> Retained<NEFilterDataVerdict>

This class method returns a verdict indicating that a “content blocked” page should be displayed to the user. The block page should contain a link to the given URL.

Parameter remediationURLMapKey: Remediation map key used by data plugin to get remediation url. Passing nil will result into data provider being notified with the callback handleRemediationForFlow:

Parameter remediationButtonTextMapKey: Remediation button map key used by the data plugin to get the remediation button text. Passing nil will set the button text to “Request Access”

Returns: The NEFilterDataVerdict object.

Source

pub unsafe fn dataVerdictWithPassBytes_peekBytes( pass_bytes: NSUInteger, peek_bytes: NSUInteger, ) -> Retained<NEFilterDataVerdict>

This class method returns a data verdict indicating that the filter is passing a given number of bytes through the filter and needs to see a given number of bytes after the bytes that are passed.

Parameter passBytes: The number of bytes to pass through the filter.

Parameter peekBytes: The number of bytes after the end of the bytes passed that the filter wants to see in the next call to -[NEFilterDataProvider handleOutboundDataFromFlow:readBytesStartOffset:readBytes:] or -[NEFilterDataProvider handleInboundDataFromFlow:readBytesStartOffset:readBytes:].

Returns: The data flow verdict.

Source

pub unsafe fn needRulesVerdict() -> Retained<NEFilterDataVerdict>

This class method returns a verdict indicating that control provider needs to be asked how to handle the data flow. The control provider can either drop or allow the flow, or update the rules and ask the data provider to decide on the data flow again.

Returns: The NEFilterDataVerdict object.

Source

pub unsafe fn pauseVerdict() -> Retained<NEFilterDataVerdict>

This class method returns a verdict indicating that none of the data provider’s handler callbacks shall be called for the flow until after the flow is resumed by a call to -[NEFilterDataProvider resumeFlow:withVerdict:]. TCP flows may be paused indefinitely. UDP flows will be dropped if not resumed within 10 seconds of being paused. It is invalid to pause a flow that is already paused.

Returns: The NEFilterDataVerdict object.

Source §

impl NEFilterDataVerdict

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