Struct WKWebExtensionMatchPattern

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

Available on crate feature WKWebExtensionMatchPattern only.

A WKWebExtensionMatchPattern object represents a way to specify groups of URLs.

All match patterns are specified as strings. Apart from the special <all _urls> pattern, match patterns consist of three parts: scheme, host, and path.

See also Apple’s documentation

Implementations

impl WKWebExtensionMatchPattern

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

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

pub unsafe fn registerCustomURLScheme( url_scheme: &NSString, mtm: MainThreadMarker, )

Registers a custom URL scheme that can be used in match patterns.

This method should be used to register any custom URL schemes used by the app for the extension base URLs, other than webkit-extension, or if extensions should have access to other supported URL schemes when using <all _urls>.

Parameter urlScheme: The custom URL scheme to register.

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

Returns a pattern object for <all _urls>.

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

Returns a pattern object that has * for scheme, host, and path.

pub unsafe fn matchPatternWithString( string: &NSString, mtm: MainThreadMarker, ) -> Option<Retained<Self>>

Returns a pattern object for the specified pattern string.

Returns: Returns nil if the pattern string is invalid.

See also: initWithString:error:

pub unsafe fn matchPatternWithScheme_host_path( scheme: &NSString, host: &NSString, path: &NSString, mtm: MainThreadMarker, ) -> Option<Retained<Self>>

Returns a pattern object for the specified scheme, host, and path strings.

Returns: A pattern object, or nil if any of the strings are invalid.

See also: initWithScheme:host:path:error:

pub unsafe fn initWithString_error( this: Allocated<Self>, string: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

Returns a pattern object for the specified pattern string.

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

Returns: A pattern object, or nil if the pattern string is invalid and an error will be set.

See also: initWithString:

pub unsafe fn initWithScheme_host_path_error( this: Allocated<Self>, scheme: &NSString, host: &NSString, path: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

Returns a pattern object for the specified scheme, host, and path strings.

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

Returns: A pattern object, or nil if any of the strings are invalid and an error will be set.

See also: initWithScheme:host:path:

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

The original pattern string.

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

The scheme part of the pattern string, unless matchesAllURLs is YES.

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

The host part of the pattern string, unless matchesAllURLs is YES.

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

The path part of the pattern string, unless matchesAllURLs is YES.

pub unsafe fn matchesAllURLs(&self) -> bool

If the pattern is <all _urls>.

pub unsafe fn matchesAllHosts(&self) -> bool

If the pattern is <all _urls> or has * as the host.

pub unsafe fn matchesURL(&self, url: Option<&NSURL>) -> bool

Matches the reciever pattern against the specified URL.

Parameter url: The URL to match the against the reciever pattern.

Returns: A Boolean value indicating if pattern matches the specified URL.

See also: matchesURL:options:

pub unsafe fn matchesURL_options( &self, url: Option<&NSURL>, options: WKWebExtensionMatchPatternOptions, ) -> bool

Matches the reciever pattern against the specified URL with options.

Parameter url: The URL to match the against the reciever pattern.

Parameter options: The options to use while matching.

Returns: A Boolean value indicating if pattern matches the specified URL.

See also: matchesURL:

pub unsafe fn matchesPattern( &self, pattern: Option<&WKWebExtensionMatchPattern>, ) -> bool

Matches the receiver pattern against the specified pattern.

Parameter pattern: The pattern to match against the receiver pattern.

Returns: A Boolean value indicating if receiver pattern matches the specified pattern.

See also: matchesPattern:options:

pub unsafe fn matchesPattern_options( &self, pattern: Option<&WKWebExtensionMatchPattern>, options: WKWebExtensionMatchPatternOptions, ) -> bool

Matches the receiver pattern against the specified pattern with options.

Parameter pattern: The pattern to match against the receiver pattern.

Parameter options: The options to use while matching.

Returns: A Boolean value indicating if receiver pattern matches the specified pattern.

See also: matchesPattern:

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 WKWebExtensionMatchPattern

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKWebExtensionMatchPattern

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKWebExtensionMatchPattern> for WKWebExtensionMatchPattern

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKWebExtensionMatchPattern

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKWebExtensionMatchPattern

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WKWebExtensionMatchPattern

const NAME: &'static str = "WKWebExtensionMatchPattern"

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 CopyingHelper for WKWebExtensionMatchPattern

type Result = WKWebExtensionMatchPattern

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

impl Debug for WKWebExtensionMatchPattern

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

Formats the value using the given formatter.

impl Deref for WKWebExtensionMatchPattern

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKWebExtensionMatchPattern

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 WKWebExtensionMatchPattern

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for WKWebExtensionMatchPattern

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSCopying for WKWebExtensionMatchPattern

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 WKWebExtensionMatchPattern

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 WKWebExtensionMatchPattern

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for WKWebExtensionMatchPattern

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 WKWebExtensionMatchPattern

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

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

impl DowncastTarget for WKWebExtensionMatchPattern

impl Eq for WKWebExtensionMatchPattern