Struct xpcom::interfaces::nsIRandomAccessIterator

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

interface nsIRandomAccessIterator : nsISupports

/**
   * ...
   */

Methods

impl nsIRandomAccessIterator

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

Cast this nsIRandomAccessIterator to one of its base interfaces.

impl nsIRandomAccessIterator

pub unsafe fn GetElement(&self, _retval: *mut *const nsISupports) -> nsresult

/**
       * Retrieve (and |AddRef()|) the element this iterator currently points to.
       *
       * The result is undefined if this iterator currently points outside the
       * useful range of the underlying container or sequence.
       *
       * @result a new reference to the element this iterator currently points to (if any)
       */

nsISupports getElement ();

pub unsafe fn GetElementAt(
    &self,
    anOffset: int32_t,
    _retval: *mut *const nsISupports
) -> nsresult

/**
       * Retrieve (and |AddRef()|) an element at some offset from where this iterator currently points.
       * The offset may be negative.  |getElementAt(0)| is equivalent to |getElement()|.
       *
       * The result is undefined if this iterator currently points outside the
       * useful range of the underlying container or sequence.
       *
       * @param anOffset a |0|-based offset from the position to which this iterator currently points
       * @result a new reference to the indicated element (if any)
       */

nsISupports getElementAt (in int32_t anOffset);

pub unsafe fn PutElement(&self, anElementToPut: *const nsISupports) -> nsresult

/**
       * Put |anElementToPut| into the underlying container or sequence at the position currently pointed to by this iterator.
       * The iterator and the underlying container or sequence cooperate to |Release()|
       * the replaced element, if any and if necessary, and to |AddRef()| the new element.
       *
       * The result is undefined if this iterator currently points outside the
       * useful range of the underlying container or sequence.
       *
       * @param anElementToPut the element to place into the underlying container or sequence
       */

void putElement (in nsISupports anElementToPut);

pub unsafe fn PutElementAt(
    &self,
    anOffset: int32_t,
    anElementToPut: *const nsISupports
) -> nsresult

/**
       * Put |anElementToPut| into the underlying container or sequence at the position |anOffset| away from that currently pointed to by this iterator.
       * The iterator and the underlying container or sequence cooperate to |Release()|
       * the replaced element, if any and if necessary, and to |AddRef()| the new element.
       * |putElementAt(0, obj)| is equivalent to |putElement(obj)|.
       *
       * The result is undefined if this iterator currently points outside the
       * useful range of the underlying container or sequence.
       *
       * @param anOffset a |0|-based offset from the position to which this iterator currently points
       * @param anElementToPut the element to place into the underlying container or sequence
       */

void putElementAt (in int32_t anOffset, in nsISupports anElementToPut);

pub unsafe fn StepForward(&self) -> nsresult

/**
       * Advance this iterator to the next position in the underlying container or sequence.
       */

void stepForward ();

pub unsafe fn StepForwardBy(&self, anOffset: int32_t) -> nsresult

/**
       * Move this iterator by |anOffset| positions in the underlying container or sequence.
       * |anOffset| may be negative.  |stepForwardBy(1)| is equivalent to |stepForward()|.
       * |stepForwardBy(0)| is a no-op.
       *
       * @param anOffset a |0|-based offset from the position to which this iterator currently points
       */

void stepForwardBy (in int32_t anOffset);

pub unsafe fn StepBackward(&self) -> nsresult

/**
       * Move this iterator to the previous position in the underlying container or sequence.
       */

void stepBackward ();

pub unsafe fn StepBackwardBy(&self, anOffset: int32_t) -> nsresult

/**
       * Move this iterator backwards by |anOffset| positions in the underlying container or sequence.
       * |anOffset| may be negative.  |stepBackwardBy(1)| is equivalent to |stepBackward()|.
       * |stepBackwardBy(n)| is equivalent to |stepForwardBy(-n)|.  |stepBackwardBy(0)| is a no-op.
       *
       * @param anOffset a |0|-based offset from the position to which this iterator currently points
       */

void stepBackwardBy (in int32_t anOffset);

pub unsafe fn IsEqualTo(
    &self,
    anotherIterator: *const nsISupports,
    _retval: *mut bool
) -> nsresult

/**
       * Test if |anotherIterator| points to the same position in the underlying container or sequence.
       *
       * The result is undefined if |anotherIterator| was not created by or for the same underlying container or sequence.
       *
       * @param anotherIterator another iterator to compare against, created by or for the same underlying container or sequence
       * @result true if |anotherIterator| points to the same position in the underlying container or sequence
       */

boolean isEqualTo (in nsISupports anotherIterator);

pub unsafe fn Clone(&self, _retval: *mut *const nsISupports) -> nsresult

/**
       * Create a new iterator pointing to the same position in the underlying container or sequence to which this iterator currently points.
       * The returned iterator is suitable for use in a subsequent call to |isEqualTo()| against this iterator.
       *
       * @result a new iterator pointing at the same position in the same underlying container or sequence as this iterator
       */

nsISupports clone ();

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 nsIRandomAccessIterator

const IID: nsIID

IID: nsIID = nsID(2614558128, 7633, 4530, [145, 1, 209, 83, 117, 150, 130, 48])

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 nsIRandomAccessIterator

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIRandomAccessIterator

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.