Struct NEFilterManager

Source

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

Expand description

The NEFilterManager class declares the programmatic interface for an object that manages content filtering configurations.

NEFilterManager declares methods and properties for configuring and controlling a filter.

Instances of this class are thread safe.

Implementations§

Source §

impl NEFilterManager

Source

pub unsafe fn sharedManager() -> Retained<NEFilterManager>

Returns: The singleton NEFilterManager object for the calling process.

Source

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

Available on crate feature block2 only.

This function loads the current filter configuration from the caller’s filter preferences.

Parameter completionHandler: A block that will be called when the load operation is completed. The NSError passed to this block will be nil if the load operation succeeded, non-nil otherwise.

Source

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

Available on crate feature block2 only.

This function removes the filter configuration from the caller’s filter preferences. If the filter is enabled, the filter becomes disabled.

Parameter completionHandler: A block that will be called when the remove operation is completed. The NSError passed to this block will be nil if the remove operation succeeded, non-nil otherwise.

Source

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

Available on crate feature block2 only.

This function saves the filter configuration in the caller’s filter preferences. If the filter is enabled, it will become active.

Parameter completionHandler: A block that will be called when the save operation is completed. The NSError passed to this block will be nil if the save operation succeeded, non-nil otherwise.

Source

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

A string containing a description of the filter.

Source

pub unsafe fn setLocalizedDescription( &self, localized_description: Option<&NSString>, )

Setter for localizedDescription.

Source

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

An NEFilterProviderConfiguration object containing the provider-specific portion of the filter configuration.

Source

pub unsafe fn setProviderConfiguration( &self, provider_configuration: Option<&NEFilterProviderConfiguration>, )

Setter for providerConfiguration.

Source

pub unsafe fn isEnabled(&self) -> bool

Toggles the enabled status of the filter. On iOS, setting this property will disable filter configurations of other apps, and this property will be set to NO when other filter configurations are enabled. On macOS, up to 4 filter configurations of the same grade can be enabled simultaneously.

Source

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

Source

pub unsafe fn grade(&self) -> NEFilterManagerGrade

The grade of the filter. The default grade is NEFilterManagerGradeFirewall.

Source

pub unsafe fn setGrade(&self, grade: NEFilterManagerGrade)

Setter for grade.

Source

pub unsafe fn disableEncryptedDNSSettings(&self) -> bool

Causes the content filter to disable any other installed encrypted DNS settings, including iCloud Private Relay system-wide DNS encryption. This should only be used if the content filter expects to intercept cleartext UDP DNS packets.

Source

pub unsafe fn setDisableEncryptedDNSSettings( &self, disable_encrypted_dns_settings: bool, )

Setter for disableEncryptedDNSSettings.

Source §

impl NEFilterManager

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