Struct WebDataSource

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

👎Deprecated

Available on crate feature WebDataSource only.

A WebDataSource represents the data associated with a web page. A datasource has a WebDocumentRepresentation which holds an appropriate representation of the data. WebDataSources manage a hierarchy of WebFrames. WebDataSources are typically related to a view by their containing WebFrame.

See also Apple’s documentation

Implementations

impl WebDataSource

pub unsafe fn initWithRequest( this: Allocated<Self>, request: Option<&NSURLRequest>, ) -> Option<Retained<Self>>

👎Deprecated

The designated initializer for WebDataSource.

Parameter request: The request to use in creating a datasource.

Returns: Returns an initialized WebDataSource.

pub unsafe fn data(&self) -> Retained<NSData>

👎Deprecated

Returns the raw data associated with the datasource. Returns nil if the datasource hasn’t loaded any data.

The data will be incomplete until the datasource has completely loaded.

pub unsafe fn representation( &self, ) -> Option<Retained<ProtocolObject<dyn WebDocumentRepresentation>>>

👎Deprecated

Available on crate feature WebDocument only.

The representation associated with this datasource. Returns nil if the datasource hasn’t created its representation.

A representation holds a type specific representation of the datasource’s data. The representation class is determined by mapping a MIME type to a class. The representation is created once the MIME type of the datasource content has been determined.

pub unsafe fn webFrame(&self) -> Option<Retained<WebFrame>>

👎Deprecated

Available on crate feature WebFrame only.

The frame that represents this data source.

pub unsafe fn initialRequest(&self) -> Option<Retained<NSURLRequest>>

👎Deprecated

A reference to the original request that created the datasource. This request will be unmodified by WebKit.

pub unsafe fn request(&self) -> Option<Retained<NSMutableURLRequest>>

👎Deprecated

The request that was used to create this datasource.

pub unsafe fn response(&self) -> Option<Retained<NSURLResponse>>

👎Deprecated

The NSURLResponse for the data source.

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

👎Deprecated

Returns either the override encoding, as set on the WebView for this dataSource or the encoding from the response.

pub unsafe fn isLoading(&self) -> bool

👎Deprecated

Returns YES if there are any pending loads.

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

👎Deprecated

The page title or nil.

pub unsafe fn unreachableURL(&self) -> Option<Retained<NSURL>>

👎Deprecated

The unreachableURL for which this dataSource is showing alternate content, or nil.

This will be non-nil only for dataSources created by calls to the WebFrame method loadAlternateHTMLString:baseURL:forUnreachableURL:.

pub unsafe fn webArchive(&self) -> Option<Retained<WebArchive>>

👎Deprecated

Available on crate feature WebArchive only.

A WebArchive representing the data source, its subresources and child frames. This method constructs a WebArchive using the original downloaded data. In the case of HTML, if the current state of the document is preferred, webArchive should be called on the DOM document instead.

pub unsafe fn mainResource(&self) -> Option<Retained<WebResource>>

👎Deprecated

Available on crate feature WebResource only.

A WebResource representing the data source. This method constructs a WebResource using the original downloaded data. This method can be used to construct a WebArchive in case the archive returned by WebDataSource’s webArchive isn’t sufficient.

pub unsafe fn subresources(&self) -> Retained<NSArray>

👎Deprecated

All the subresources associated with the data source. The returned array only contains subresources that have fully downloaded.

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

👎Deprecated

Available on crate feature WebResource only.

method subresourceForURL:

Returns a subresource for a given URL.

Parameter URL: The URL of the subresource. Returns non-nil if the data source has fully downloaded a subresource with the given URL.

pub unsafe fn addSubresource(&self, subresource: Option<&WebResource>)

👎Deprecated

Available on crate feature WebResource only.

Adds a subresource to the data source.

Parameter subresource: The subresource to be added. addSubresource: adds a subresource to the data source’s list of subresources. Later, if something causes the data source to load the URL of the subresource, the data source will load the data from the subresource instead of from the network. For example, if one wants to add an image that is already downloaded to a web page, addSubresource: can be called so that the data source uses the downloaded image rather than accessing the network. NOTE: If the data source already has a subresource with the same URL, addSubresource: will replace it.

impl WebDataSource

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.

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 WebDataSource

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WebDataSource

fn as_ref(&self) -> &NSObject

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

impl AsRef<WebDataSource> for WebDataSource

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WebDataSource

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WebDataSource

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WebDataSource

const NAME: &'static str = "WebDataSource"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for WebDataSource

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WebDataSource

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 WebDataSource

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for WebDataSource

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 WebDataSource

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 WebDataSource

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

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

impl DowncastTarget for WebDataSource

impl Eq for WebDataSource