Struct NEFilterDataProvider

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

The NEFilterDataProvider class declares the programmatic interface for an object that evaluates network data flows based on a set of locally-available rules and makes decisions about whether to block or allow the flows.

See also Apple’s documentation

Implementations

impl NEFilterDataProvider

pub unsafe fn handleNewFlow( &self, flow: &NEFilterFlow, ) -> Retained<NEFilterNewFlowVerdict>

This function is called by the framework when a filtering decision needs to be made about a new network data flow. Subclasses must override this method to implement the steps necessary to match the flow against some locally stored rules and return an appropriate verdict.

Parameter flow: An NEFilterFlow object containing details about the new flow.

Returns: An NEFilterNewFlowVerdict object containing the verdict for the new flow.

pub unsafe fn handleInboundDataFromFlow_readBytesStartOffset_readBytes( &self, flow: &NEFilterFlow, offset: NSUInteger, read_bytes: &NSData, ) -> Retained<NEFilterDataVerdict>

This function is called by the framework when a filtering decision needs to be made about some inbound data that the filter previously requested access to via the NEFilterFlowDataVerdict or the NEFilterNewFlowVerdict. Subclasses must override this method.

Parameter flow: The NEFilterFlow from which the data was read.

Parameter offset: The offset in bytes from the start of the flow’s inbound data at which readBytes begins.

Parameter readBytes: The data that was read. For non-UDP/TCP flows, since data may optionally include the IP header, readBytes includes a 4-bytes NEFilterDataAttribute field preceding the user data. Handler must examine the NEFilterDataAttribute field and handle the data accordingly.

Returns: An NEFilterFlowDataVerdict containing the verdict for the flow.

pub unsafe fn handleOutboundDataFromFlow_readBytesStartOffset_readBytes( &self, flow: &NEFilterFlow, offset: NSUInteger, read_bytes: &NSData, ) -> Retained<NEFilterDataVerdict>

This function is called by the framework when a filtering decision needs to be made about some outbound data that the filter previously requested access to via the NEFilterFlowDataVerdict or the NEFilterNewFlowVerdict. Subclasses must override this method.

Parameter flow: The NEFilterFlow from which the data was read.

Parameter offset: The offset in bytes from the start of the flow’s outbound data at which readBytes begins.

Parameter readBytes: The data that was read. For non-UDP/TCP flows, since data may optionally include the IP header, readBytes includes a 4-bytes NEFilterDataAttribute field preceding the user data. Handler must examine the NEFilterDataAttribute field and handle the data accordingly.

Returns: An NEFilterFlowDataVerdict containing the verdict for the flow.

pub unsafe fn handleInboundDataCompleteForFlow( &self, flow: &NEFilterFlow, ) -> Retained<NEFilterDataVerdict>

This function is called by the framework after all of the inbound data for a flow has been seen by the filter. Subclasses must override this method to return an appropriate pass/block result.

Parameter flow: The flow

Returns: The final NEFilterFlowDataVerdict verdict for the flow.

pub unsafe fn handleOutboundDataCompleteForFlow( &self, flow: &NEFilterFlow, ) -> Retained<NEFilterDataVerdict>

This function is called by the framework after all of the outbound data for a flow has been seen by the filter. Subclasses must override this method to return an appropriate pass/block result.

Parameter flow: The flow

Returns: The final NEFilterFlowDataVerdict verdict for the flow.

pub unsafe fn handleRemediationForFlow( &self, flow: &NEFilterFlow, ) -> Retained<NEFilterRemediationVerdict>

This function is called by the framework after the user requests remediation for a blocked flow. Subclasses must override this method to return an appropriate pass/block result.

Parameter flow: The flow

Returns: The final NEFilterRemediationVerdict verdict for the flow.

pub unsafe fn handleRulesChanged(&self)

This function is called by the framework when -[NEFilterControlProvider notifyRulesChanged] is called. Subclasses should override this method to reload new rules from disk.

pub unsafe fn applySettings_completionHandler( &self, settings: Option<&NEFilterSettings>, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

The provider calls this function to apply the current set of filtering rules associated with the provider and also change the default filtering action.

Parameter settings: A NEFilterSettings object containing the filter settings to apply to the system. Pass nil to revert to the default settings, which are an empty list of rules and a default action of NEFilterActionFilterData.

Parameter completionHandler: A block that will be executed when the settings have been applied to the system. If an error occurs then the error parameter will be non-nil.

pub unsafe fn resumeFlow_withVerdict( &self, flow: &NEFilterFlow, verdict: &NEFilterVerdict, )

This function is called by the provider to resume a flow that was previously paused by the provider returning a pause verdict.

Parameter flow: The flow to resume

Parameter verdict: The next NEFilterDataVerdict for the flow. This verdict is used as the verdict corresponding to the flow handler callback (handleNewFlow:, handleInboundDataFromFlow:, etc.) that returned the pause verdict that paused the flow. This must be either a NEFilterDataVerdict or a NEFilterNewFlowVerdict. It is invalid to resume a flow that is not paused.

pub unsafe fn updateFlow_usingVerdict_forDirection( &self, flow: &NEFilterSocketFlow, verdict: &NEFilterDataVerdict, direction: NETrafficDirection, )

This function is called by the provider to update the verdict for a flow outside the context of any NEFilterDataProvider callback.

Parameter flow: The NEFilterSocketFlow to update the verdict for.

Parameter verdict: The NEFilterDataVerdict. Must be a +[NEFilterDataVerdict allowVerdict], a +[NEFilterDataVerdict dropVerdict], or a +[NEFilterDataVerdict dataVerdictWithPassBytes:peekBytes:].

Parameter direction: The direction to which the verdict applies. Pass NETrafficDirectionAny to update the verdict for both the inbound and outbound directions. This parameter is ignored if the verdict is +[NEFilterDataVerdict dropVerdict].

impl NEFilterDataProvider

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NEFilterProvider>

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

Available on crate feature block2 only.

This function is called by the framework when the content filter is being started. Subclasses must override this method and perform whatever steps are necessary to start the filter.

Parameter completionHandler: A block that must be called when the process of starting the filter is complete. If the filter was started successfully, subclass implementations must pass the nil value to this block. If an error occurred while starting the filter, sublcass implementations must pass a non-nil NSError containing more details about the error.

pub unsafe fn stopFilterWithReason_completionHandler( &self, reason: NEProviderStopReason, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

This function is called by the framework when the content filter is being stopped. Subclasses must override this method and perform whatever steps are necessary to stop the filter.

Parameter reason: An NEProviderStopReason indicating why the filter is being stopped.

Parameter completionHandler: A block that must be called when the process of stopping the filter is complete.

pub unsafe fn filterConfiguration( &self, ) -> Retained<NEFilterProviderConfiguration>

An NEContentFilterConfiguration object containing the current filter configuration. The value of this property can change during the lifetime of a filter. Filter implementations can use KVO to be notified when the configuration changes.

pub unsafe fn handleReport(&self, report: &NEFilterReport)

This function is called by the framework when the data provider extension returns a verdict with the report property set to True. Subclass implementations may override this method to handle the flow report.

Parameter report: The report being delivered.

Methods from Deref<Target = NEProvider>

pub unsafe fn sleepWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

This function is called by the framework when the system is about to go to sleep. Subclass developers can override this method to implement custom behavior such as closing connections or pausing some network activity.

Parameter completionHandler: When the method is finished handling the sleep event it must execute this completion handler.

pub unsafe fn wake(&self)

This function is called by the framework immediately after the system wakes up from sleep. Subclass developers can override this method to implement custom behavior such as re-establishing connections or resuming some network activity.

pub unsafe fn createTCPConnectionToEndpoint_enableTLS_TLSParameters_delegate( &self, remote_endpoint: &NWEndpoint, enable_tls: bool, tls_parameters: Option<&NWTLSParameters>, delegate: Option<&AnyObject>, ) -> Retained<NWTCPConnection>

👎Deprecated: Use nw_connection_t in Network framework instead

This function can be called by subclass implementations to create a TCP connection to a given network endpoint. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote network endpoint to connect to.

Parameter enableTLS: A flag indicating if a TLS session should be negotiated on the connection.

Parameter TLSParameters: A set of optional TLS parameters. Only valid if enableTLS is YES. If TLSParameters is nil, the default system parameters will be used for TLS negotiation.

Parameter delegate: An object to use as the connections delegate. This object should conform to the NWTCPConnectionAuthenticationDelegate protocol.

Returns: An NWTCPConnection object.

pub unsafe fn createUDPSessionToEndpoint_fromEndpoint( &self, remote_endpoint: &NWEndpoint, local_endpoint: Option<&NWHostEndpoint>, ) -> Retained<NWUDPSession>

👎Deprecated: Use nw_connection_t in Network framework instead

This function can be called by subclass implementations to create a UDP session between a local network endpoint and a remote network endpoint. This function should not be overridden by subclasses.

Parameter remoteEndpoint: An NWEndpoint object that specifies the remote endpoint to which UDP datagrams will be sent by the UDP session.

Parameter localEndpoint: An NWHostEndpoint object that specifies the local IP address endpoint to use as the source endpoint of the UDP session.

Returns: An NWUDPSession object.

pub unsafe fn displayMessage_completionHandler( &self, message: &NSString, completion_handler: &DynBlock<dyn Fn(Bool)>, )

👎Deprecated

Available on crate feature block2 only.

This method can be called by subclass implementations to display a message to the user.

Parameter message: The message to be displayed.

Parameter completionHandler: A block that is executed when the user acknowledges the message. If this method is called on a NEFilterDataProvider instance or the message cannot be displayed, then the completion handler block will be executed immediately with success parameter set to NO. If the message was successfully displayed to the user, then the completion handler block is executed with the success parameter set to YES when the user dismisses the message.

pub unsafe fn defaultPath(&self) -> Option<Retained<NWPath>>

👎Deprecated: Use nw_path_monitor_t in Network framework instead

The current default path for connections created by the provider. Use KVO to watch for network changes.

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 NEFilterDataProvider

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NEFilterDataProvider> for NEFilterDataProvider

fn as_ref(&self) -> &Self

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

impl AsRef<NEFilterProvider> for NEFilterDataProvider

fn as_ref(&self) -> &NEFilterProvider

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

impl AsRef<NEProvider> for NEFilterDataProvider

fn as_ref(&self) -> &NEProvider

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

impl AsRef<NSObject> for NEFilterDataProvider

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NEFilterDataProvider

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NEFilterProvider> for NEFilterDataProvider

fn borrow(&self) -> &NEFilterProvider

Immutably borrows from an owned value.

impl Borrow<NEProvider> for NEFilterDataProvider

fn borrow(&self) -> &NEProvider

Immutably borrows from an owned value.

impl Borrow<NSObject> for NEFilterDataProvider

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NEFilterDataProvider

const NAME: &'static str = "NEFilterDataProvider"

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

type Super = NEFilterProvider

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NEFilterDataProvider

type Target = NEFilterProvider

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NEFilterDataProvider

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 NEFilterDataProvider

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NEFilterDataProvider

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 NEFilterDataProvider

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 NEFilterDataProvider

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

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

impl DowncastTarget for NEFilterDataProvider

impl Eq for NEFilterDataProvider