Struct NEFilterProviderConfiguration

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

The NEFilterProviderConfiguration class declares the programmatic interface of an object that configures a plugin-based content filter.

See also Apple’s documentation

Implementations

impl NEFilterProviderConfiguration

pub unsafe fn filterBrowsers(&self) -> bool

👎Deprecated: filterBrowsers is not supported on macOS

If YES, the filter plugin will be allowed to filter browser traffic. If NO, the filter plugin will not see any browser flows. Defaults to NO. At least one of filterBrowsers and filterSockets should be set to YES to make the filter take effect.

pub unsafe fn setFilterBrowsers(&self, filter_browsers: bool)

👎Deprecated: filterBrowsers is not supported on macOS

Setter for filterBrowsers.

pub unsafe fn filterSockets(&self) -> bool

If YES, the filter plugin will be allowed to filter socket traffic. If NO, the filter plugin will not see any socket flows. Defaults to NO. At least one of filterBrowsers and filterSockets should be set to YES to make the filter take effect.

pub unsafe fn setFilterSockets(&self, filter_sockets: bool)

Setter for filterSockets.

pub unsafe fn filterPackets(&self) -> bool

If YES, a NEFilterPacketProvider will be instantiated and will be allowed to filter packets.

pub unsafe fn setFilterPackets(&self, filter_packets: bool)

Setter for filterPackets.

pub unsafe fn vendorConfiguration( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>

An optional dictionary of plugin-specific keys to be passed to the plugin.

pub unsafe fn setVendorConfiguration( &self, vendor_configuration: Option<&NSDictionary<NSString, AnyObject>>, )

Setter for vendorConfiguration.

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

The optional address of the server used to support the filter.

pub unsafe fn setServerAddress(&self, server_address: Option<&NSString>)

Setter for serverAddress.

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

The optional username associated with the filter.

pub unsafe fn setUsername(&self, username: Option<&NSString>)

Setter for username.

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

The optional organization associated with the filter.

pub unsafe fn setOrganization(&self, organization: Option<&NSString>)

Setter for organization.

pub unsafe fn passwordReference(&self) -> Option<Retained<NSData>>

The optional password keychain reference associated with the filter.

pub unsafe fn setPasswordReference(&self, password_reference: Option<&NSData>)

Setter for passwordReference.

pub unsafe fn identityReference(&self) -> Option<Retained<NSData>>

The optional certificate identity keychain reference associated with the filter.

pub unsafe fn setIdentityReference(&self, identity_reference: Option<&NSData>)

Setter for identityReference.

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

A string containing the bundle identifier of the NEFilterDataProvider app extension or system extension. If this property is nil, then the bundle identifier of the NEFilterDataProvider extension in the calling app’s bundle is used, and if the calling app’s bundle contains more than one NEFilterDataProvider extension then which one will be used is undefined.

pub unsafe fn setFilterDataProviderBundleIdentifier( &self, filter_data_provider_bundle_identifier: Option<&NSString>, )

Setter for filterDataProviderBundleIdentifier.

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

A string containing the bundle identifier of the NEFilterPacketProvider app extension or system extension. If this property is nil, then the bundle identifier of the NEFilterPacketProvider extension in the calling app’s bundle is used, and if the calling app’s bundle contains more than one NEFilterPacketProvider extension then which one will be used is undefined.

pub unsafe fn setFilterPacketProviderBundleIdentifier( &self, filter_packet_provider_bundle_identifier: Option<&NSString>, )

Setter for filterPacketProviderBundleIdentifier.

impl NEFilterProviderConfiguration

Methods declared on superclass NSObject.

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

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

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 NEFilterProviderConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NEFilterProviderConfiguration> for NEFilterProviderConfiguration

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NEFilterProviderConfiguration

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NEFilterProviderConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NEFilterProviderConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NEFilterProviderConfiguration

const NAME: &'static str = "NEFilterProviderConfiguration"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NEFilterProviderConfiguration 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 CopyingHelper for NEFilterProviderConfiguration

type Result = NEFilterProviderConfiguration

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NEFilterProviderConfiguration

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

Formats the value using the given formatter.

impl Deref for NEFilterProviderConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NEFilterProviderConfiguration

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 NEFilterProviderConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NEFilterProviderConfiguration

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NEFilterProviderConfiguration

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 NSSecureCoding for NEFilterProviderConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NEFilterProviderConfiguration

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 NEFilterProviderConfiguration

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

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

impl DowncastTarget for NEFilterProviderConfiguration

impl Eq for NEFilterProviderConfiguration

impl NSCoding for NEFilterProviderConfiguration