Struct NSXMLDocument

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

Available on crate features NSXMLDocument and NSXMLNode only.

An XML Document

Note: if the application of a method would result in more than one element in the children array, an exception is thrown. Trying to add a document, namespace, attribute, or node with a parent also throws an exception. To add a node with a parent first detach or create a copy of it.

See also Apple’s documentation

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.

Returns a document created from either XML or HTML, if the HTMLTidy option is set. Parse errors are returned in error .

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.

Returns a document created from the contents of an XML or HTML URL. Connection problems such as 404, parse errors are returned in error .

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.

Returns a document created from data. Parse errors are returned in error .

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

Available on crate feature NSXMLElement only.

Returns a document with a single child, the root element.

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

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

Available on crate feature NSString only.

Sets the character encoding to an IANA type.

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

Available on crate feature NSString only.

Setter for characterEncoding.

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

Available on crate feature NSString only.

Sets the XML version. Should be 1.0 or 1.1.

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

Available on crate feature NSString only.

Setter for version.

pub unsafe fn isStandalone(&self) -> bool

Set whether this document depends on an external DTD. If this option is set the standalone declaration will appear on output.

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

Setter for isStandalone.

pub unsafe fn documentContentKind(&self) -> NSXMLDocumentContentKind

The kind of document.

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

Setter for documentContentKind.

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

Available on crate feature NSString only.

Set the MIME type, eg text/xml.

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

Available on crate feature NSString only.

Setter for MIMEType.

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

Available on crate feature NSXMLDTD only.

Set the associated DTD. This DTD will be output with the document.

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

Available on crate feature NSXMLDTD only.

Setter for DTD.

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

Available on crate feature NSXMLElement only.

Set the root element. Removes all other children including comments and processing-instructions.

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

Available on crate feature NSXMLElement only.

The root element.

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

Inserts a child at a particular index.

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

Available on crate feature NSArray only.

Insert several children at a particular index.

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

Removes a child at a particular index.

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

Available on crate feature NSArray only.

Removes all existing children and replaces them with the new children. Set children to nil to simply remove all children.

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

Adds a child to the end of the existing children.

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

Replaces a child at a particular index with another child.

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

Available on crate feature NSData only.

Invokes XMLDataWithOptions with NSXMLNodeOptionsNone.

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

Available on crate features NSData and NSXMLNodeOptions only.

The representation of this node as it would appear in an XML document, encoded based on characterEncoding.

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.

Applies XSLT with arguments (NSString key/value pairs) to this document, returning a new document.

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.

Applies XSLT as expressed by a string with arguments (NSString key/value pairs) to this document, returning a new document.

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.

Applies the XSLT at a URL with arguments (NSString key/value pairs) to this document, returning a new document. Error may contain a connection error from the URL.

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>

Invokes

 initWithKind:options:

with options set to NSXMLNodeOptionsNone

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

Available on crate feature NSXMLNodeOptions only.

Inits a node with fidelity options as description NSXMLNodeOptions.h

impl NSXMLDocument

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSXMLNode>

pub unsafe fn kind(&self) -> NSXMLNodeKind

Returns an element, attribute, entity, or notation DTD node based on the full XML string.

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

Available on crate feature NSString only.

Sets the nodes name. Applicable for element, attribute, namespace, processing-instruction, document type declaration, element declaration, attribute declaration, entity declaration, and notation declaration.

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

Available on crate feature NSString only.

Setter for name.

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

Sets the content of the node. Setting the objectValue removes all existing children including processing instructions and comments. Setting the object value on an element creates a single text node child.

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

Setter for objectValue.

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

Available on crate feature NSString only.

Sets the content of the node. Setting the stringValue removes all existing children including processing instructions and comments. Setting the string value on an element creates a single text node child. The getter returns the string value of the node, which may be either its content or child text nodes, depending on the type of node. Elements are recursed and text nodes concatenated in document order with no intervening spaces.

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

Available on crate feature NSString only.

Setter for stringValue.

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

Available on crate feature NSString only.

Sets the content as with

 setStringValue:

, but when “resolve” is true, character references, predefined entities and user entities available in the document’s dtd are resolved. Entities not available in the dtd remain in their entity form.

pub unsafe fn index(&self) -> NSUInteger

A node’s index amongst its siblings.

pub unsafe fn level(&self) -> NSUInteger

The depth of the node within the tree. Documents and standalone nodes are level 0.

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

The encompassing document or nil.

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

The parent of this node. Documents and standalone Nodes have a nil parent; there is not a 1-to-1 relationship between parent and children, eg a namespace cannot be a child but has a parent element.

pub unsafe fn childCount(&self) -> NSUInteger

The amount of children, relevant for documents, elements, and document type declarations. Use this instead of [[self children] count].

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

Available on crate feature NSArray only.

An immutable array of child nodes. Relevant for documents, elements, and document type declarations.

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

Returns the child node at a particular index.

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

Returns the previous sibling, or nil if there isn’t one.

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

Returns the next sibling, or nil if there isn’t one.

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

Returns the previous node in document order. This can be used to walk the tree backwards.

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

Returns the next node in document order. This can be used to walk the tree forwards.

pub unsafe fn detach(&self)

Detaches this node from its parent.

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

Available on crate feature NSString only.

Returns the XPath to this node, for example foo/bar[2]/baz.

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

Available on crate feature NSString only.

Returns the local name bar if this attribute or element’s name is foo:bar

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

Available on crate feature NSString only.

Returns the prefix foo if this attribute or element’s name if foo:bar

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

Available on crate feature NSString only.

Set the URI of this element, attribute, or document. For documents it is the URI of document origin. Getter returns the URI of this element, attribute, or document. For documents it is the URI of document origin and is automatically set when using initWithContentsOfURL.

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

Available on crate feature NSString only.

Setter for URI.

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

Available on crate feature NSString only.

Used for debugging. May give more information than XMLString.

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

Available on crate feature NSString only.

The representation of this node as it would appear in an XML document.

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

Available on crate features NSString and NSXMLNodeOptions only.

The representation of this node as it would appear in an XML document, with various output options available.

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

Available on crate feature NSString only.

W3 canonical form (http://www.w3.org/TR/xml-c14n). The input option NSXMLNodePreserveWhitespace should be set for true canonical form.

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

Available on crate features NSArray and NSError and NSString only.

Returns the nodes resulting from applying an XPath to this node using the node as the context item (“.”). normalizeAdjacentTextNodesPreservingCDATA:NO should be called if there are adjacent text nodes since they are not allowed under the XPath/XQuery Data Model.

Returns: An array whose elements are a kind of NSXMLNode.

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.

Returns the objects resulting from applying an XQuery to this node using the node as the context item (“.”). Constants are a name-value dictionary for constants declared “external” in the query. normalizeAdjacentTextNodesPreservingCDATA:NO should be called if there are adjacent text nodes since they are not allowed under the XPath/XQuery Data Model.

Returns: An array whose elements are kinds of NSArray, NSData, NSDate, NSNumber, NSString, NSURL, or NSXMLNode.

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.

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

const NAME: &'static str = "NSXMLDocument"

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

type Super = NSXMLNode

The superclass of this class.

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

Available on crate feature NSObject only.

type Result = NSXMLDocument

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

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

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NSXMLDocument

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

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

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,

Available on crate feature NSObject only.

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

impl NSObjectProtocol for NSXMLDocument

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 NSXMLDocument

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 NSXMLDocument

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

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

impl DowncastTarget for NSXMLDocument

impl Eq for NSXMLDocument