Struct xpcom::interfaces::nsISAXAttributes

#[repr(C)]
pub struct nsISAXAttributes { /* fields omitted */ }

interface nsISAXAttributes : nsISupports

/**
 * Interface for a list of XML attributes.
 *
 * This interface allows access to a list of attributes in
 * three different ways:
 *
 * 1.) by attribute index;
 * 2.) by Namespace-qualified name; or
 * 3.) by XML qualified name.
 *
 * The list will not contain attributes that were declared #IMPLIED
 * but not specified in the start tag.  It will also not contain
 * attributes used as Namespace declarations (xmlns*) unless the
 * http://xml.org/sax/features/namespace-prefixes feature
 * is set to true (it is false by default).
 *
 * The order of attributes in the list is unspecified.
 */

Methods

impl nsISAXAttributes

pub fn coerce<T: nsISAXAttributesCoerce>(&self) -> &T

Cast this nsISAXAttributes to one of its base interfaces.

impl nsISAXAttributes

pub unsafe fn GetIndexFromName(
    &self,
    uri: &nsAString,
    localName: &nsAString,
    _retval: *mut int32_t
) -> nsresult

/**
   * Look up the index of an attribute by Namespace name.
   * @param uri The Namespace URI, or the empty string
   *            if the name has no Namespace URI.
   * @param localName The attribute's local name.
   * @return The index of the attribute, or -1
   *         if it does not appear in the list.
   */

long getIndexFromName (in AString uri, in AString localName);

pub unsafe fn GetIndexFromQName(
    &self,
    qName: &nsAString,
    _retval: *mut int32_t
) -> nsresult

/**
   * Look up the index of an attribute by XML qualified name.
   * @param qName The qualified name.
   * @return The index of the attribute, or -1
   *         if it does not appear in the list.
   */

long getIndexFromQName (in AString qName);

pub unsafe fn GetLength(&self, aLength: *mut int32_t) -> nsresult

/**
   * Return the number of attributes in the list. Once you know the
   * number of attributes, you can iterate through the list.
   *
   * @return The number of attributes in the list.
   */

readonly attribute long length;

pub unsafe fn GetLocalName(
    &self,
    index: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's local name by index.
   * @param index The attribute index (zero-based).
   * @return The local name, or null if the index is out of range.
   */

AString getLocalName (in unsigned long index);

pub unsafe fn GetQName(
    &self,
    index: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's XML qualified name by index.
   * @param index The attribute index (zero-based).
   * @return The XML qualified name, or the empty string if none is
   *         available, or null if the index is out of range.
   */

AString getQName (in unsigned long index);

pub unsafe fn GetType(
    &self,
    index: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's type by index. The attribute type is one
   * of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN",
   * "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper
   * case). If the parser has not read a declaration for the
   * attribute, or if the parser does not report attribute types, then
   * it must return the value "CDATA" as stated in the XML 1.0
   * Recommendation (clause 3.3.3, "Attribute-Value
   * Normalization"). For an enumerated attribute that is not a
   * notation, the parser will report the type as "NMTOKEN".
   *
   * @param index The attribute index (zero-based).
   * @return The attribute's type as a string, or null if the index is
   *         out of range.
   */

AString getType (in unsigned long index);

pub unsafe fn GetTypeFromName(
    &self,
    uri: &nsAString,
    localName: &nsAString,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's type by Namespace name.
   * @param uri The Namespace URI, or the empty string
   *             if the name has no Namespace URI.
   * @param localName The attribute's local name.
   * @return The attribute type as a string, or null if the attribute
   *         is not in the list.
   */

AString getTypeFromName (in AString uri, in AString localName);

pub unsafe fn GetTypeFromQName(
    &self,
    qName: &nsAString,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's type by XML qualified name.
   * @param qName The qualified name.
   * @return The attribute type as a string, or null if the attribute
   *         is not in the list.
   */

AString getTypeFromQName (in AString qName);

pub unsafe fn GetURI(
    &self,
    index: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's Namespace URI by index.
   * @param index The attribute index (zero-based).
   * @return The Namespace URI, or the empty string if none is available,
   *         or null if the index is out of range.
   */

AString getURI (in unsigned long index);

pub unsafe fn GetValue(
    &self,
    index: uint32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's value by index.  If the attribute value is
   * a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will
   * be concatenated into a single string with each token separated by
   * a single space.
   *
   * @param index The attribute index (zero-based).
   * @return The attribute's value as a string, or null if the index is
   *         out of range.
   */

AString getValue (in unsigned long index);

pub unsafe fn GetValueFromName(
    &self,
    uri: &nsAString,
    localName: &nsAString,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's value by Namespace name.  If the attribute
   * value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the
   * tokens will be concatenated into a single string with each token
   * separated by a single space.
   *
   * @param uri The Namespace URI, or the empty string
   *             if the name has no Namespace URI.
   * @param localName The attribute's local name.
   * @return The attribute's value as a string, or null if the attribute is
   *         not in the list.
   */

AString getValueFromName (in AString uri, in AString localName);

pub unsafe fn GetValueFromQName(
    &self,
    qName: &nsAString,
    _retval: &mut nsAString
) -> nsresult

/**
   * Look up an attribute's value by XML qualified (prefixed) name.
   * If the attribute value is a list of tokens (IDREFS, ENTITIES, or
   * NMTOKENS), the tokens will be concatenated into a single string
   * with each token separated by a single space.
   *
   * @param qName The qualified (prefixed) name.
   * @return The attribute's value as a string, or null if the attribute is
   *         not in the list.
   */

AString getValueFromQName (in AString qName);

Methods from Deref<Target = nsISupports>

pub fn coerce<T: nsISupportsCoerce>(&self) -> &T

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &self,
    uuid: &nsIID,
    result: *mut *mut c_void
) -> nsresult

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

pub unsafe fn AddRef(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsISAXAttributes

const IID: nsIID

IID: nsIID = nsID(3813081182, 27856, 4570, [190, 67, 0, 20, 34, 16, 105, 144])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsISAXAttributes

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsISAXAttributes

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.