Struct WKWebExtensionControllerConfiguration

Source

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

Available on crate feature WKWebExtensionControllerConfiguration only.

Expand description

A WKWebExtensionControllerConfiguration object with which to initialize a web extension controller.

Contains properties used to configure a WKWebExtensionController.

Implementations§

Source §

pub unsafe fn defaultConfiguration(mtm: MainThreadMarker) -> Retained<Self>

Returns a new default configuration that is persistent and not unique.

If a WKWebExtensionController is associated with a persistent configuration, data will be written to the file system in a common location. When using multiple extension controllers, each controller should use a unique configuration to avoid conflicts.

pub unsafe fn nonPersistentConfiguration( mtm: MainThreadMarker, ) -> Retained<Self>

Returns a new non-persistent configuration.

If a WKWebExtensionController is associated with a non-persistent configuration, no data will be written to the file system. This is useful for extensions in “private browsing” situations.

Source

pub unsafe fn configurationWithIdentifier( identifier: &NSUUID, mtm: MainThreadMarker, ) -> Retained<Self>

Returns a new configuration that is persistent and unique for the specified identifier.

If a WKWebExtensionController is associated with a unique persistent configuration, data will be written to the file system in a unique location based on the specified identifier.

pub unsafe fn isPersistent(&self) -> bool

A Boolean value indicating if this context will write data to the the file system.

Source

pub unsafe fn identifier(&self) -> Option<Retained<NSUUID>>

The unique identifier used for persistent configuration storage, or nil when it is the default or not persistent.

Source

pub unsafe fn webViewConfiguration(&self) -> Retained<WKWebViewConfiguration>

Available on crate feature WKWebViewConfiguration only.

The web view configuration to be used as a basis for configuring web views in extension contexts.

Source

pub unsafe fn setWebViewConfiguration( &self, web_view_configuration: Option<&WKWebViewConfiguration>, )

Available on crate feature WKWebViewConfiguration only.

Setter for webViewConfiguration.

Source

pub unsafe fn defaultWebsiteDataStore( &self, ) -> Option<Retained<WKWebsiteDataStore>>

Available on crate feature WKWebsiteDataStore only.

The default data store for website data and cookie access in extension contexts.

This property sets the primary data store for managing website data, including cookies, which extensions can access, subject to the granted permissions within the extension contexts. Defaults to WKWebsiteDataStore.defaultDataStore.

Note: In addition to this data store, extensions can also access other data stores, such as non-persistent ones, for any open tabs.

Source

pub unsafe fn setDefaultWebsiteDataStore( &self, default_website_data_store: Option<&WKWebsiteDataStore>, )

Available on crate feature WKWebsiteDataStore only.

Setter for defaultWebsiteDataStore.

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