Struct DOMTreeWalker

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

👎Deprecated

Available on crate features DOMObject and DOMTreeWalker and WebScriptObject only.

Apple’s documentation

Implementations

impl DOMTreeWalker

pub unsafe fn root(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn whatToShow(&self) -> c_uint

👎Deprecated

pub unsafe fn filter( &self, ) -> Option<Retained<ProtocolObject<dyn DOMNodeFilter>>>

👎Deprecated

Available on crate feature DOMNodeFilter only.

pub unsafe fn expandEntityReferences(&self) -> bool

👎Deprecated

pub unsafe fn currentNode(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn setCurrentNode(&self, current_node: Option<&DOMNode>)

👎Deprecated

Available on crate feature DOMNode only.

Setter for currentNode.

pub unsafe fn parentNode(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn firstChild(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn lastChild(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn previousSibling(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn nextSibling(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn previousNode(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

pub unsafe fn nextNode(&self) -> Option<Retained<DOMNode>>

👎Deprecated

Available on crate feature DOMNode only.

impl DOMTreeWalker

Methods declared on superclass DOMObject.

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

👎Deprecated

impl DOMTreeWalker

Methods declared on superclass NSObject.

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

Methods from Deref<Target = DOMObject>

pub unsafe fn sheet(&self) -> Option<Retained<DOMStyleSheet>>

Available on crate feature DOMStyleSheet only.

Methods from Deref<Target = WebScriptObject>

pub unsafe fn callWebScriptMethod_withArguments( &self, name: Option<&NSString>, arguments: Option<&NSArray>, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter name: The name of the method to call in the script environment.

Parameter arguments: The arguments to pass to the script environment.

Calls the specified method in the script environment using the specified arguments.

Returns: Returns the result of calling the script method. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn evaluateWebScript( &self, script: Option<&NSString>, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter script: The script to execute in the target script environment.

The script will be executed in the target script environment. The format of the script is dependent of the target script environment.

Returns: Returns the result of evaluating the script in the script environment. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn removeWebScriptKey(&self, name: Option<&NSString>)

👎Deprecated

Parameter name: The name of the property to remove.

Removes the property from the object in the script environment.

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

👎Deprecated

Converts the target object to a string representation. The coercion of non string objects type is dependent on the script environment.

Returns: Returns the string representation of the object.

pub unsafe fn webScriptValueAtIndex( &self, index: c_uint, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter index: The index of the property to return.

Gets the value of the property at the specified index.

Returns: The value of the property. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn setWebScriptValueAtIndex_value( &self, index: c_uint, value: Option<&AnyObject>, )

👎Deprecated

Parameter index: The index of the property to set.

Parameter value: The value of the property to set.

Sets the property value at the specified index.

pub unsafe fn setException(&self, description: Option<&NSString>)

👎Deprecated

Parameter description: The description of the exception.

Raises an exception in the script environment in the context of the current object.

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 DOMTreeWalker

fn as_ref(&self) -> &AnyObject

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

impl AsRef<DOMObject> for DOMTreeWalker

fn as_ref(&self) -> &DOMObject

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

impl AsRef<DOMTreeWalker> for DOMTreeWalker

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for DOMTreeWalker

fn as_ref(&self) -> &NSObject

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

impl AsRef<WebScriptObject> for DOMTreeWalker

fn as_ref(&self) -> &WebScriptObject

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

impl Borrow<AnyObject> for DOMTreeWalker

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<DOMObject> for DOMTreeWalker

fn borrow(&self) -> &DOMObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for DOMTreeWalker

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<WebScriptObject> for DOMTreeWalker

fn borrow(&self) -> &WebScriptObject

Immutably borrows from an owned value.

impl ClassType for DOMTreeWalker

const NAME: &'static str = "DOMTreeWalker"

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

type Super = DOMObject

The superclass of this class.

type ThreadKind = <<DOMTreeWalker 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 CopyingHelper for DOMTreeWalker

type Result = DOMTreeWalker

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

impl Debug for DOMTreeWalker

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

Formats the value using the given formatter.

impl Deref for DOMTreeWalker

type Target = DOMObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for DOMTreeWalker

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 DOMTreeWalker

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for DOMTreeWalker

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 DOMTreeWalker

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 DOMTreeWalker

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 DOMTreeWalker

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

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

impl DowncastTarget for DOMTreeWalker

impl Eq for DOMTreeWalker