Struct objc2_foundation::NSXMLDocument

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

Available on crate features NSXMLDocument and NSXMLNode only.

Implementations

impl NSXMLDocument

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

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

Available on crate features NSError and NSString and NSXMLNodeOptions only.

pub unsafe fn initWithContentsOfURL_options_error( this: Allocated<Self>, url: &NSURL, mask: NSXMLNodeOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL and NSXMLNodeOptions only.

pub unsafe fn initWithData_options_error( this: Allocated<Self>, data: &NSData, mask: NSXMLNodeOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSData and NSError and NSXMLNodeOptions only.

pub unsafe fn initWithRootElement( this: Allocated<Self>, element: Option<&NSXMLElement> ) -> Retained<Self>

Available on crate feature NSXMLElement only.

pub unsafe fn replacementClassForClass(cls: &AnyClass) -> &'static AnyClass

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

Available on crate feature NSString only.

pub unsafe fn setCharacterEncoding(&self, character_encoding: Option<&NSString>)

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn setVersion(&self, version: Option<&NSString>)

Available on crate feature NSString only.

pub unsafe fn isStandalone(&self) -> bool

pub unsafe fn setStandalone(&self, standalone: bool)

pub unsafe fn documentContentKind(&self) -> NSXMLDocumentContentKind

pub unsafe fn setDocumentContentKind( &self, document_content_kind: NSXMLDocumentContentKind )

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

Available on crate feature NSString only.

pub unsafe fn setMIMEType(&self, mime_type: Option<&NSString>)

Available on crate feature NSString only.

pub unsafe fn DTD(&self) -> Option<Retained<NSXMLDTD>>

Available on crate feature NSXMLDTD only.

pub unsafe fn setDTD(&self, dtd: Option<&NSXMLDTD>)

Available on crate feature NSXMLDTD only.

pub unsafe fn setRootElement(&self, root: &NSXMLElement)

Available on crate feature NSXMLElement only.

pub unsafe fn rootElement(&self) -> Option<Retained<NSXMLElement>>

Available on crate feature NSXMLElement only.

pub unsafe fn insertChild_atIndex(&self, child: &NSXMLNode, index: NSUInteger)

pub unsafe fn insertChildren_atIndex( &self, children: &NSArray<NSXMLNode>, index: NSUInteger )

Available on crate feature NSArray only.

pub unsafe fn removeChildAtIndex(&self, index: NSUInteger)

pub unsafe fn setChildren(&self, children: Option<&NSArray<NSXMLNode>>)

Available on crate feature NSArray only.

pub unsafe fn addChild(&self, child: &NSXMLNode)

pub unsafe fn replaceChildAtIndex_withNode( &self, index: NSUInteger, node: &NSXMLNode )

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

Available on crate feature NSData only.

pub unsafe fn XMLDataWithOptions( &self, options: NSXMLNodeOptions ) -> Retained<NSData>

Available on crate features NSData and NSXMLNodeOptions only.

pub unsafe fn objectByApplyingXSLT_arguments_error( &self, xslt: &NSData, arguments: Option<&NSDictionary<NSString, NSString>> ) -> Result<Retained<AnyObject>, Retained<NSError>>

Available on crate features NSData and NSDictionary and NSError and NSString only.

pub unsafe fn objectByApplyingXSLTString_arguments_error( &self, xslt: &NSString, arguments: Option<&NSDictionary<NSString, NSString>> ) -> Result<Retained<AnyObject>, Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn objectByApplyingXSLTAtURL_arguments_error( &self, xslt_url: &NSURL, argument: Option<&NSDictionary<NSString, NSString>> ) -> Result<Retained<AnyObject>, Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString and NSURL only.

pub unsafe fn validateAndReturnError(&self) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

impl NSXMLDocument

Methods declared on superclass NSXMLNode

pub unsafe fn initWithKind( this: Allocated<Self>, kind: NSXMLNodeKind ) -> Retained<Self>

pub unsafe fn initWithKind_options( this: Allocated<Self>, kind: NSXMLNodeKind, options: NSXMLNodeOptions ) -> Retained<Self>

Available on crate feature NSXMLNodeOptions only.

impl NSXMLDocument

Methods declared on superclass NSObject

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

Methods from Deref<Target = NSXMLNode>

pub unsafe fn kind(&self) -> NSXMLNodeKind

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn objectValue(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setObjectValue(&self, object_value: Option<&AnyObject>)

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

Available on crate feature NSString only.

pub unsafe fn setStringValue(&self, string_value: Option<&NSString>)

Available on crate feature NSString only.

pub unsafe fn setStringValue_resolvingEntities( &self, string: &NSString, resolve: bool )

Available on crate feature NSString only.

pub unsafe fn index(&self) -> NSUInteger

pub unsafe fn level(&self) -> NSUInteger

pub unsafe fn rootDocument(&self) -> Option<Retained<NSXMLDocument>>

pub unsafe fn parent(&self) -> Option<Retained<NSXMLNode>>

pub unsafe fn childCount(&self) -> NSUInteger

pub unsafe fn children(&self) -> Option<Retained<NSArray<NSXMLNode>>>

Available on crate feature NSArray only.

pub unsafe fn childAtIndex( &self, index: NSUInteger ) -> Option<Retained<NSXMLNode>>

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

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

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

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

pub unsafe fn detach(&self)

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn setURI(&self, uri: Option<&NSString>)

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn XMLStringWithOptions( &self, options: NSXMLNodeOptions ) -> Retained<NSString>

Available on crate features NSString and NSXMLNodeOptions only.

pub unsafe fn canonicalXMLStringPreservingComments( &self, comments: bool ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn nodesForXPath_error( &self, xpath: &NSString ) -> Result<Retained<NSArray<NSXMLNode>>, Retained<NSError>>

Available on crate features NSArray and NSError and NSString only.

pub unsafe fn objectsForXQuery_constants_error( &self, xquery: &NSString, constants: Option<&NSDictionary<NSString, AnyObject>> ) -> Result<Retained<NSArray>, Retained<NSError>>

Available on crate features NSArray and NSDictionary and NSError and NSString only.

pub unsafe fn objectsForXQuery_error( &self, xquery: &NSString ) -> Result<Retained<NSArray>, Retained<NSError>>

Available on crate features NSArray and NSError and NSString only.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSXMLDocument

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for NSXMLDocument

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<NSXMLDocument> for NSXMLDocument

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<NSXMLNode> for NSXMLDocument

fn as_mut(&mut self) -> &mut NSXMLNode

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

impl AsRef<AnyObject> for NSXMLDocument

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSXMLDocument

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSXMLDocument> for NSXMLDocument

fn as_ref(&self) -> &Self

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

impl AsRef<NSXMLNode> for NSXMLDocument

fn as_ref(&self) -> &NSXMLNode

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

impl Borrow<AnyObject> for NSXMLDocument

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSXMLDocument

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSXMLNode> for NSXMLDocument

fn borrow(&self) -> &NSXMLNode

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSXMLDocument

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSXMLDocument

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl BorrowMut<NSXMLNode> for NSXMLDocument

fn borrow_mut(&mut self) -> &mut NSXMLNode

Mutably borrows from an owned value.

impl ClassType for NSXMLDocument

type Super = NSXMLNode

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSXMLDocument"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSXMLDocument

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

Formats the value using the given formatter.

impl Deref for NSXMLDocument

type Target = NSXMLNode

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSXMLDocument

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for NSXMLDocument

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 NSCopying for NSXMLDocument

Available on crate feature NSObject only.

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSXMLDocument

fn isEqual(&self, other: &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,

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 NSXMLDocument

fn eq(&self, other: &NSXMLDocument) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSXMLDocument

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

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

impl Eq for NSXMLDocument

impl Message for NSXMLDocument

impl StructuralPartialEq for NSXMLDocument