Struct SFSafariExtensionHandler 

pub struct SFSafariExtensionHandler { /* private fields */ }

Available on crate feature SFSafariExtensionHandler only.

Apple’s documentation

Implementations

impl SFSafariExtensionHandler

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 SFSafariExtensionHandler

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SFSafariExtensionHandler

fn as_ref(&self) -> &NSObject

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

impl AsRef<SFSafariExtensionHandler> for SFSafariExtensionHandler

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SFSafariExtensionHandler

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SFSafariExtensionHandler

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SFSafariExtensionHandler

const NAME: &'static str = "SFSafariExtensionHandler"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for SFSafariExtensionHandler

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SFSafariExtensionHandler

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 SFSafariExtensionHandler

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSExtensionRequestHandling for SFSafariExtensionHandler

fn beginRequestWithExtensionContext(&self, context: &NSExtensionContext)

where Self: Sized + Message,

impl NSObjectProtocol for SFSafariExtensionHandler

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 SFSafariExtensionHandler

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 SFSafariExtensionHandler

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

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

impl SFSafariExtensionHandling for SFSafariExtensionHandler

unsafe fn messageReceivedWithName_fromPage_userInfo( &self, message_name: &NSString, page: &SFSafariPage, user_info: Option<&NSDictionary<NSString, AnyObject>>, )

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariPage only.

This is called when a content script from an extension dispatches a message to the app extension.

unsafe fn messageReceivedFromContainingAppWithName_userInfo( &self, message_name: &NSString, user_info: Option<&NSDictionary<NSString, AnyObject>>, )

where Self: Sized + Message,

Available on crate feature SFSafariExtensionHandling only.

This is called when the extension’s containing app dispatches a message to the app extension.

unsafe fn toolbarItemClickedInWindow(&self, window: &SFSafariWindow)

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariWindow only.

This is called when the extension’s toolbar item is clicked.

unsafe fn validateToolbarItemInWindow_validationHandler( &self, window: &SFSafariWindow, validation_handler: &DynBlock<dyn Fn(Bool, NonNull<NSString>)>, )

where Self: Sized + Message,

Available on crate features SFSafariWindow and block2 and SFSafariExtensionHandling only.

This is called when Safari’s state changed in some way that would require the extension’s toolbar item to be validated again.

unsafe fn contextMenuItemSelectedWithCommand_inPage_userInfo( &self, command: &NSString, page: &SFSafariPage, user_info: Option<&NSDictionary<NSString, AnyObject>>, )

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariPage only.

This is called when one of the extension’s context menu items is selected.

unsafe fn validateContextMenuItemWithCommand_inPage_userInfo_validationHandler( &self, command: &NSString, page: &SFSafariPage, user_info: Option<&NSDictionary<NSString, AnyObject>>, validation_handler: &DynBlock<dyn Fn(Bool, *mut NSString)>, )

where Self: Sized + Message,

Available on crate features SFSafariPage and block2 and SFSafariExtensionHandling only.

This is called before context menu is shown, and provides a way to validate individual context menu items.

unsafe fn popoverWillShowInWindow(&self, window: &SFSafariWindow)

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariWindow only.

This is called when the extension’s popover is about to be opened.

unsafe fn popoverDidCloseInWindow(&self, window: &SFSafariWindow)

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariWindow only.

This is called after the extension’s popover is closed.

unsafe fn popoverViewController( &self, mtm: MainThreadMarker, ) -> Retained<SFSafariExtensionViewController>

where Self: Sized + Message,

Available on crate feature SFSafariExtensionViewController and crate feature objc2-app-kit and crate feature SFSafariExtensionHandling and macOS only.

Returns the extension popover’s view controller.

unsafe fn additionalRequestHeadersForURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSString, NSString>)>, )

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and block2 only.

This is called when Safari is about to load a page that the extension has stated it wants to add additional headers for.

unsafe fn contentBlockerWithIdentifier_blockedResourcesWithURLs_onPage( &self, content_blocker_identifier: &NSString, urls: &NSArray<NSURL>, page: &SFSafariPage, )

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariPage only.

This is called when a content blocker associated with this Safari App Extension performs a blocking action.

unsafe fn page_willNavigateToURL( &self, page: &SFSafariPage, url: Option<&NSURL>, )

where Self: Sized + Message,

Available on crate features SFSafariExtensionHandling and SFSafariPage only.

This is called when a page in Safari navigates to a URL. The URL will be nil when the extension doesn’t have access to it.

impl DowncastTarget for SFSafariExtensionHandler

impl Eq for SFSafariExtensionHandler