Struct WKWebExtensionController

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

Available on crate feature WKWebExtensionController only.

A WKWebExtensionController object manages a set of loaded extension contexts.

You can have one or more extension controller instances, allowing different parts of the app to use different sets of extensions. A controller is associated with WKWebView via the webExtensionController property on WKWebViewConfiguration.

See also Apple’s documentation

Implementations

impl WKWebExtensionController

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

Returns a web extension controller initialized with the default configuration.

Returns: An initialized web extension controller, or nil if the object could not be initialized.

This is a designated initializer. You can use initWithConfiguration: to initialize an instance with a configuration.

See also: initWithConfiguration:

pub unsafe fn initWithConfiguration( this: Allocated<Self>, configuration: &WKWebExtensionControllerConfiguration, ) -> Retained<Self>

Available on crate feature WKWebExtensionControllerConfiguration only.

Returns a web extension controller initialized with the specified configuration.

Parameter configuration: The configuration for the new web extension controller.

Returns: An initialized web extension controller, or nil if the object could not be initialized.

This is a designated initializer. You can use init: to initialize an instance with the default configuration. The initializer copies the specified configuration, so mutating the configuration after invoking the initializer has no effect on the web extension controller.

See also: init

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn WKWebExtensionControllerDelegate>>>

Available on crate feature WKWebExtensionControllerDelegate only.

The extension controller delegate.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn WKWebExtensionControllerDelegate>>, )

Available on crate feature WKWebExtensionControllerDelegate only.

This is a weak property. Setter for delegate.

pub unsafe fn configuration( &self, ) -> Retained<WKWebExtensionControllerConfiguration>

Available on crate feature WKWebExtensionControllerConfiguration only.

A copy of the configuration with which the web extension controller was initialized.

Mutating the configuration has no effect on the web extension controller.

pub unsafe fn loadExtensionContext_error( &self, extension_context: &WKWebExtensionContext, ) -> Result<(), Retained<NSError>>

Available on crate feature WKWebExtensionContext only.

Loads the specified extension context.

Causes the context to start, loading any background content, and injecting any content into relevant tabs.

Parameter error: Set to nilor an NSErrorinstance if an error occurred.

Returns: A Boolean value indicating if the context was successfully loaded.

See also: loadExtensionContext:

pub unsafe fn unloadExtensionContext_error( &self, extension_context: &WKWebExtensionContext, ) -> Result<(), Retained<NSError>>

Available on crate feature WKWebExtensionContext only.

Unloads the specified extension context.

Causes the context to stop running.

Parameter error: Set to nilor an NSErrorinstance if an error occurred.

Returns: A Boolean value indicating if the context was successfully unloaded.

See also: unloadExtensionContext:

pub unsafe fn extensionContextForExtension( &self, extension: &WKWebExtension, ) -> Option<Retained<WKWebExtensionContext>>

Available on crate features WKWebExtension and WKWebExtensionContext only.

Returns a loaded extension context for the specified extension.

Parameter extension: An extension to lookup.

Returns: An extension context or nil if no match was found.

See also: extensions

pub unsafe fn extensionContextForURL( &self, url: &NSURL, ) -> Option<Retained<WKWebExtensionContext>>

Available on crate feature WKWebExtensionContext only.

Returns a loaded extension context matching the specified URL.

Parameter URL: The URL to lookup.

Returns: An extension context or nil if no match was found.

This method is useful for determining the extension context to use when about to navigate to an extension URL. For example, you could use this method to retrieve the appropriate extension context and then use its webViewConfiguration property to configure a web view for loading that URL.

pub unsafe fn extensions(&self) -> Retained<NSSet<WKWebExtension>>

Available on crate feature WKWebExtension only.

A set of all the currently loaded extensions.

See also: extensionContexts

pub unsafe fn extensionContexts(&self) -> Retained<NSSet<WKWebExtensionContext>>

Available on crate feature WKWebExtensionContext only.

A set of all the currently loaded extension contexts.

See also: extensions

pub unsafe fn allExtensionDataTypes( mtm: MainThreadMarker, ) -> Retained<NSSet<WKWebExtensionDataType>>

Available on crate feature WKWebExtensionDataType only.

Returns a set of all available extension data types.

pub unsafe fn fetchDataRecordsOfTypes_completionHandler( &self, data_types: &NSSet<WKWebExtensionDataType>, completion_handler: &DynBlock<dyn Fn(NonNull<NSArray<WKWebExtensionDataRecord>>)>, )

Available on crate features WKWebExtensionDataRecord and WKWebExtensionDataType and block2 only.

Fetches data records containing the given extension data types for all known extensions.

Parameter dataTypes: The extension data types to fetch records for.

Parameter completionHandler: A block to invoke when the data records have been fetched.

Note: The extension does not need to be loaded to be included in the result.

pub unsafe fn fetchDataRecordOfTypes_forExtensionContext_completionHandler( &self, data_types: &NSSet<WKWebExtensionDataType>, extension_context: &WKWebExtensionContext, completion_handler: &DynBlock<dyn Fn(*mut WKWebExtensionDataRecord)>, )

Available on crate features WKWebExtensionContext and WKWebExtensionDataRecord and WKWebExtensionDataType and block2 only.

Fetches a data record containing the given extension data types for a specific known web extension context.

Parameter dataTypes: The extension data types to fetch records for.

Parameter extensionContext: The specific web extension context to fetch records for.

Parameter completionHandler: A block to invoke when the data record has been fetched.

Note: The extension does not need to be loaded to be included in the result.

pub unsafe fn removeDataOfTypes_fromDataRecords_completionHandler( &self, data_types: &NSSet<WKWebExtensionDataType>, data_records: &NSArray<WKWebExtensionDataRecord>, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate features WKWebExtensionDataRecord and WKWebExtensionDataType and block2 only.

Removes extension data of the given types for the given data records.

Parameter dataTypes: The extension data types that should be removed.

Parameter dataRecords: The extension data records to delete data from.

Parameter completionHandler: A block to invoke when the data has been removed.

pub unsafe fn didOpenWindow( &self, new_window: &ProtocolObject<dyn WKWebExtensionWindow>, )

Available on crate feature WKWebExtensionWindow only.

Should be called by the app when a new window is opened to fire appropriate events with all loaded web extensions.

Parameter newWindow: The newly opened window.

This method informs all loaded extensions of the opening of a new window, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

See also: didCloseWindow:

pub unsafe fn didCloseWindow( &self, closed_window: &ProtocolObject<dyn WKWebExtensionWindow>, )

Available on crate feature WKWebExtensionWindow only.

Should be called by the app when a window is closed to fire appropriate events with all loaded web extensions.

Parameter newWindow: The window that was closed.

This method informs all loaded extensions of the closure of a window, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

See also: didOpenWindow:

pub unsafe fn didFocusWindow( &self, focused_window: Option<&ProtocolObject<dyn WKWebExtensionWindow>>, )

Available on crate feature WKWebExtensionWindow only.

Should be called by the app when a window gains focus to fire appropriate events with all loaded web extensions.

Parameter focusedWindow: The window that gained focus, or nilif no window has focus or a window has focus that is not visible to extensions.

This method informs all loaded extensions of the focused window, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

pub unsafe fn didOpenTab(&self, new_tab: &ProtocolObject<dyn WKWebExtensionTab>)

Available on crate feature WKWebExtensionTab only.

Should be called by the app when a new tab is opened to fire appropriate events with all loaded web extensions.

Parameter newTab: The newly opened tab.

This method informs all loaded extensions of the opening of a new tab, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

See also: didCloseTab:

pub unsafe fn didCloseTab_windowIsClosing( &self, closed_tab: &ProtocolObject<dyn WKWebExtensionTab>, window_is_closing: bool, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when a tab is closed to fire appropriate events with all loaded web extensions.

Parameter closedTab: The tab that was closed.

Parameter windowIsClosing: A boolean value indicating whether the window containing the tab is also closing.

This method informs all loaded extensions of the closing of a tab, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

See also: didOpenTab:

pub unsafe fn didActivateTab_previousActiveTab( &self, activated_tab: &ProtocolObject<dyn WKWebExtensionTab>, previous_tab: Option<&ProtocolObject<dyn WKWebExtensionTab>>, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when a tab is activated to notify all loaded web extensions.

Parameter activatedTab: The tab that has become active.

Parameter previousTab: The tab that was active before. This parameter can be nilif there was no previously active tab.

This method informs all loaded extensions of the tab activation, ensuring consistent state awareness across extensions. If the intention is to inform only a specific extension, use the respective method on that extension’s context instead.

pub unsafe fn didSelectTabs( &self, selected_tabs: &NSArray<ProtocolObject<dyn WKWebExtensionTab>>, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when tabs are selected to fire appropriate events with all loaded web extensions.

Parameter selectedTabs: The set of tabs that were selected.

This method informs all loaded extensions that tabs have been selected, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

pub unsafe fn didDeselectTabs( &self, deselected_tabs: &NSArray<ProtocolObject<dyn WKWebExtensionTab>>, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when tabs are deselected to fire appropriate events with all loaded web extensions.

Parameter deselectedTabs: The set of tabs that were deselected.

This method informs all loaded extensions that tabs have been deselected, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

pub unsafe fn didMoveTab_fromIndex_inWindow( &self, moved_tab: &ProtocolObject<dyn WKWebExtensionTab>, index: NSUInteger, old_window: Option<&ProtocolObject<dyn WKWebExtensionWindow>>, )

Available on crate features WKWebExtensionTab and WKWebExtensionWindow only.

Should be called by the app when a tab is moved to fire appropriate events with all loaded web extensions.

Parameter movedTab: The tab that was moved.

Parameter index: The old index of the tab within the window.

Parameter oldWindow: The window that the tab was moved from, or nilif the tab is moving from no open window.

This method informs all loaded extensions of the movement of a tab, ensuring consistent understanding across extensions. If the window is staying the same, the current window should be specified. If the intention is to inform only a specific extension, use the respective method on that extension’s context instead.

pub unsafe fn didReplaceTab_withTab( &self, old_tab: &ProtocolObject<dyn WKWebExtensionTab>, new_tab: &ProtocolObject<dyn WKWebExtensionTab>, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when a tab is replaced by another tab to fire appropriate events with all loaded web extensions.

Parameter oldTab: The tab that was replaced.

Parameter newTab: The tab that replaced the old tab.

This method informs all loaded extensions of the replacement of a tab, ensuring consistent understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

pub unsafe fn didChangeTabProperties_forTab( &self, properties: WKWebExtensionTabChangedProperties, changed_tab: &ProtocolObject<dyn WKWebExtensionTab>, )

Available on crate feature WKWebExtensionTab only.

Should be called by the app when the properties of a tab are changed to fire appropriate events with all loaded web extensions.

Parameter properties: The properties of the tab that were changed.

Parameter changedTab: The tab whose properties were changed.

This method informs all loaded extensions of changes to tab properties, ensuring a unified understanding across extensions. If the intention is to inform only a specific extension, you should use the respective method on that extension’s context instead.

impl WKWebExtensionController

Methods declared on superclass NSObject.

pub unsafe fn new(mtm: MainThreadMarker) -> 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 WKWebExtensionController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKWebExtensionController

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKWebExtensionController> for WKWebExtensionController

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKWebExtensionController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKWebExtensionController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WKWebExtensionController

const NAME: &'static str = "WKWebExtensionController"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 WKWebExtensionController

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

Formats the value using the given formatter.

impl Deref for WKWebExtensionController

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKWebExtensionController

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 WKWebExtensionController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for WKWebExtensionController

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 WKWebExtensionController

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 WKWebExtensionController

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

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

impl DowncastTarget for WKWebExtensionController

impl Eq for WKWebExtensionController