Struct xpcom::interfaces::nsIFeedProgressListener [] [src]

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

interface nsIFeedProgressListener : nsIFeedResultListener

/**
 * nsIFeedProgressListener defines callbacks used during feed
 * processing.
 */

Methods

impl nsIFeedProgressListener
[src]

[src]

Cast this nsIFeedProgressListener to one of its base interfaces.

impl nsIFeedProgressListener
[src]

[src]

/**
   * ReportError will be called in the event of fatal
   * XML errors, or if the document is not a feed. The bozo
   * bit will be set if the error was due to a fatal error.
   *
   * @param errorText
   *        A short description of the error.
   * @param lineNumber
   *        The line on which the error occurred.
   */

void reportError (in AString errorText, in long lineNumber, in boolean bozo);

[src]

/**
   * StartFeed will be called as soon as a reasonable start to
   * a feed is detected.
   *
   * @param result
   *        An object implementing nsIFeedResult representing the feed
   *        and its metadata. At this point, the result has version
   *        information.
   */

void handleStartFeed (in nsIFeedResult result);

[src]

/**
   * Called when the first entry/item is encountered. In Atom, all
   * feed data is required to preceed the entries. In RSS, the data
   * usually does. If the type is one of the entry/item-only types,
   * this event will not be called.
   *
   * @param result
   *        An object implementing nsIFeedResult representing the feed
   *        and its metadata. At this point, the result will likely have
   *        most of its feed-level metadata.
   */

void handleFeedAtFirstEntry (in nsIFeedResult result);

[src]

/**
   * Called after each entry/item. If the document is a standalone
   * item or entry, this HandleFeedAtFirstEntry will not have been
   * called. Also, this entry's parent field will be null.
   *
   * @param entry
   *        An object implementing nsIFeedEntry that represents the latest
   *        entry encountered.
   * @param result
   *        An object implementing nsIFeedResult representing the feed
   *        and its metadata.
   */

void handleEntry (in nsIFeedEntry entry, in nsIFeedResult result);

Methods from Deref<Target = nsIFeedResultListener>

[src]

Cast this nsIFeedResultListener to one of its base interfaces.

[src]

/**
   * Always called, even after an error. There could be new feed-level
   * data available at this point, if it followed or was interspersed
   * with the items. Fire-and-Forget implementations only need this.
   *
   * @param result
   *        An object implementing nsIFeedResult representing the feed
   *        and its metadata.
   */

void handleResult (in nsIFeedResult result);

Trait Implementations

impl XpCom for nsIFeedProgressListener
[src]

IID: nsIID = nsID(3959250405, 28988, 16576, [173, 124, 240, 149, 17, 127, 165, 128])

[src]

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. Read more

impl RefCounted for nsIFeedProgressListener
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIFeedProgressListener
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.