Struct WKWebsiteDataStore

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

Available on crate feature WKWebsiteDataStore only.

A WKWebsiteDataStore represents various types of data that a website might make use of. This includes cookies, disk and memory caches, and persistent data such as WebSQL, IndexedDB databases, and local storage.

See also Apple’s documentation

Implementations

impl WKWebsiteDataStore

pub unsafe fn defaultDataStore( mtm: MainThreadMarker, ) -> Retained<WKWebsiteDataStore>

pub unsafe fn nonPersistentDataStore( mtm: MainThreadMarker, ) -> Retained<WKWebsiteDataStore>

Returns a new non-persistent data store.

If a WKWebView is associated with a non-persistent data store, no data will be written to the file system. This is useful for implementing “private browsing” in a web view.

pub unsafe fn new(&self) -> Retained<Self>

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

pub unsafe fn isPersistent(&self) -> bool

Whether the data store is persistent or not.

pub unsafe fn allWebsiteDataTypes( mtm: MainThreadMarker, ) -> Retained<NSSet<NSString>>

Returns a set of all available website data types.

pub unsafe fn fetchDataRecordsOfTypes_completionHandler( &self, data_types: &NSSet<NSString>, completion_handler: &Block<dyn Fn(NonNull<NSArray<WKWebsiteDataRecord>>)>, )

Available on crate features WKWebsiteDataRecord and block2 only.

Fetches data records containing the given website data types.

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

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

pub unsafe fn removeDataOfTypes_forDataRecords_completionHandler( &self, data_types: &NSSet<NSString>, data_records: &NSArray<WKWebsiteDataRecord>, completion_handler: &Block<dyn Fn()>, )

Available on crate features WKWebsiteDataRecord and block2 only.

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

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

Parameter dataRecords: The website data records to delete website data for.

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

pub unsafe fn removeDataOfTypes_modifiedSince_completionHandler( &self, data_types: &NSSet<NSString>, date: &NSDate, completion_handler: &Block<dyn Fn()>, )

Available on crate feature block2 only.

Removes all website data of the given types that has been modified since the given date.

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

Parameter date: A date. All website data modified after this date will be removed.

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

pub unsafe fn httpCookieStore(&self) -> Retained<WKHTTPCookieStore>

Available on crate feature WKHTTPCookieStore only.

Returns the cookie store representing HTTP cookies in this website data store.

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

Get identifier for a data store.

Returns nil for default and non-persistent data store .

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

Get a persistent data store.

Parameter identifier: An identifier that is used to uniquely identify the data store.

If a data store with this identifier does not exist yet, it will be created. Throws exception if identifier is 0.

pub unsafe fn removeDataStoreForIdentifier_completionHandler( identifier: &NSUUID, completion_handler: &Block<dyn Fn(*mut NSError)>, mtm: MainThreadMarker, )

Available on crate feature block2 only.

Delete a persistent data store.

Parameter identifier: An identifier that is used to uniquely identify the data store.

Parameter completionHandler: A block to invoke with optional error when the operation completes.

This should be called when the data store is not used any more. Returns error if removal fails to complete. WKWebView using the data store must be released before removal.

pub unsafe fn fetchAllDataStoreIdentifiers( completion_handler: &Block<dyn Fn(NonNull<NSArray<NSUUID>>)>, mtm: MainThreadMarker, )

Available on crate feature block2 only.

Fetch all data stores identifiers.

Parameter completionHandler: A block to invoke with an array of identifiers when the operation completes.

Default or non-persistent data store do not have an identifier.

impl WKWebsiteDataStore

Methods declared on superclass NSObject.

pub unsafe fn new_class(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.

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 WKWebsiteDataStore

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKWebsiteDataStore

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKWebsiteDataStore> for WKWebsiteDataStore

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKWebsiteDataStore

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKWebsiteDataStore

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WKWebsiteDataStore

const NAME: &'static str = "WKWebsiteDataStore"

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 WKWebsiteDataStore

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

Formats the value using the given formatter.

impl Deref for WKWebsiteDataStore

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKWebsiteDataStore

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 WKWebsiteDataStore

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for WKWebsiteDataStore

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for WKWebsiteDataStore

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 WKWebsiteDataStore

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for WKWebsiteDataStore

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 WKWebsiteDataStore

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

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

impl DowncastTarget for WKWebsiteDataStore

impl Eq for WKWebsiteDataStore