Struct xpcom::interfaces::nsIFeed

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

interface nsIFeed : nsIFeedContainer

/**
 * An nsIFeed represents a single Atom or RSS feed.
 */

Methods

impl nsIFeed

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

Cast this nsIFeed to one of its base interfaces.

impl nsIFeed

pub const TYPE_FEED: i64

TYPE_FEED: i64 = 0

pub const TYPE_AUDIO: i64

TYPE_AUDIO: i64 = 1

pub const TYPE_IMAGE: i64

TYPE_IMAGE: i64 = 2

pub const TYPE_VIDEO: i64

TYPE_VIDEO: i64 = 4

pub unsafe fn GetSubtitle(
    &self,
    aSubtitle: *mut *const nsIFeedTextConstruct
) -> nsresult

/**
  * Uses description, subtitle, and extensions
  * to generate a summary.
  */

attribute nsIFeedTextConstruct subtitle;

pub unsafe fn SetSubtitle(
    &self,
    aSubtitle: *const nsIFeedTextConstruct
) -> nsresult

/**
  * Uses description, subtitle, and extensions
  * to generate a summary.
  */

attribute nsIFeedTextConstruct subtitle;

pub unsafe fn GetType(&self, aType: *mut uint32_t) -> nsresult

/**
  * The type of feed. For example, a podcast would be TYPE_AUDIO.
  */

readonly attribute unsigned long type;

pub unsafe fn GetEnclosureCount(
    &self,
    aEnclosureCount: *mut int32_t
) -> nsresult

/**
  * The total number of enclosures found in the feed.
  */

attribute long enclosureCount;

pub unsafe fn SetEnclosureCount(&self, aEnclosureCount: int32_t) -> nsresult

/**
  * The total number of enclosures found in the feed.
  */

attribute long enclosureCount;

pub unsafe fn GetItems(&self, aItems: *mut *const nsIArray) -> nsresult

/**
  * The items or entries in feed.
  */

attribute nsIArray items;

pub unsafe fn SetItems(&self, aItems: *const nsIArray) -> nsresult

/**
  * The items or entries in feed.
  */

attribute nsIArray items;

pub unsafe fn GetCloud(
    &self,
    aCloud: *mut *const nsIWritablePropertyBag2
) -> nsresult

/**
  * No one really knows what cloud is for.
  *
  * It supposedly enables some sort of interaction with an XML-RPC or
  * SOAP service.
  */

attribute nsIWritablePropertyBag2 cloud;

pub unsafe fn SetCloud(
    &self,
    aCloud: *const nsIWritablePropertyBag2
) -> nsresult

/**
  * No one really knows what cloud is for.
  *
  * It supposedly enables some sort of interaction with an XML-RPC or
  * SOAP service.
  */

attribute nsIWritablePropertyBag2 cloud;

pub unsafe fn GetGenerator(
    &self,
    aGenerator: *mut *const nsIFeedGenerator
) -> nsresult

/**
  * Information about the software that produced the feed.
  */

attribute nsIFeedGenerator generator;

pub unsafe fn SetGenerator(
    &self,
    aGenerator: *const nsIFeedGenerator
) -> nsresult

/**
  * Information about the software that produced the feed.
  */

attribute nsIFeedGenerator generator;

pub unsafe fn GetImage(
    &self,
    aImage: *mut *const nsIWritablePropertyBag2
) -> nsresult

/**
  * An image url and some metadata (as defined by RSS2).
  *
  */

attribute nsIWritablePropertyBag2 image;

pub unsafe fn SetImage(
    &self,
    aImage: *const nsIWritablePropertyBag2
) -> nsresult

/**
  * An image url and some metadata (as defined by RSS2).
  *
  */

attribute nsIWritablePropertyBag2 image;

pub unsafe fn GetTextInput(
    &self,
    aTextInput: *mut *const nsIWritablePropertyBag2
) -> nsresult

/**
  * No one really knows what textInput is for.
  *
  * See
  * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput>
  * for more details.
  */

attribute nsIWritablePropertyBag2 textInput;

pub unsafe fn SetTextInput(
    &self,
    aTextInput: *const nsIWritablePropertyBag2
) -> nsresult

/**
  * No one really knows what textInput is for.
  *
  * See
  * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput>
  * for more details.
  */

attribute nsIWritablePropertyBag2 textInput;

pub unsafe fn GetSkipDays(&self, aSkipDays: *mut *const nsIArray) -> nsresult

/**
  * Days to skip fetching. This field was supposed to designate
  * intervals for feed fetching. It's not generally implemented. For
  * example, if this array contained "Monday", aggregators should not
  * fetch the feed on Mondays.
  */

attribute nsIArray skipDays;

pub unsafe fn SetSkipDays(&self, aSkipDays: *const nsIArray) -> nsresult

/**
  * Days to skip fetching. This field was supposed to designate
  * intervals for feed fetching. It's not generally implemented. For
  * example, if this array contained "Monday", aggregators should not
  * fetch the feed on Mondays.
  */

attribute nsIArray skipDays;

pub unsafe fn GetSkipHours(&self, aSkipHours: *mut *const nsIArray) -> nsresult

/**
  * Hours to skip fetching. This field was supposed to designate
  * intervals for feed fetching. It's not generally implemented. See
  * <http://blogs.law.harvard.edu/tech/rss> for more information.
  */

attribute nsIArray skipHours;

pub unsafe fn SetSkipHours(&self, aSkipHours: *const nsIArray) -> nsresult

/**
  * Hours to skip fetching. This field was supposed to designate
  * intervals for feed fetching. It's not generally implemented. See
  * <http://blogs.law.harvard.edu/tech/rss> for more information.
  */

attribute nsIArray skipHours;

Methods from Deref<Target = nsIFeedContainer>

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

Cast this nsIFeedContainer to one of its base interfaces.

pub unsafe fn GetId(&self, aId: &mut nsAString) -> nsresult

/**
  * Many feeds contain an ID distinct from their URI, and
  * entries have standard fields for this in all major formats.
  */

attribute AString id;

pub unsafe fn SetId(&self, aId: &nsAString) -> nsresult

/**
  * Many feeds contain an ID distinct from their URI, and
  * entries have standard fields for this in all major formats.
  */

attribute AString id;

pub unsafe fn GetFields(
    &self,
    aFields: *mut *const nsIWritablePropertyBag2
) -> nsresult

/**
  * The fields found in the document. Common Atom
  * and RSS fields are normalized. This includes some namespaced
  * extensions such as dc:subject and content:encoded.
  * Consumers can avoid normalization by checking the feed type
  * and accessing specific fields.
  *
  * Common namespaces are accessed using prefixes, like get("dc:subject");.
  * See nsIFeedResult::registerExtensionPrefix.
  */

attribute nsIWritablePropertyBag2 fields;

pub unsafe fn SetFields(
    &self,
    aFields: *const nsIWritablePropertyBag2
) -> nsresult

/**
  * The fields found in the document. Common Atom
  * and RSS fields are normalized. This includes some namespaced
  * extensions such as dc:subject and content:encoded.
  * Consumers can avoid normalization by checking the feed type
  * and accessing specific fields.
  *
  * Common namespaces are accessed using prefixes, like get("dc:subject");.
  * See nsIFeedResult::registerExtensionPrefix.
  */

attribute nsIWritablePropertyBag2 fields;

pub unsafe fn GetTitle(
    &self,
    aTitle: *mut *const nsIFeedTextConstruct
) -> nsresult

/**
   * Sometimes there's no title, or the title contains markup, so take
   * care in decoding the attribute.
   */

attribute nsIFeedTextConstruct title;

pub unsafe fn SetTitle(&self, aTitle: *const nsIFeedTextConstruct) -> nsresult

/**
   * Sometimes there's no title, or the title contains markup, so take
   * care in decoding the attribute.
   */

attribute nsIFeedTextConstruct title;

pub unsafe fn GetLink(&self, aLink: *mut *const nsIURI) -> nsresult

/**
  * Returns the primary link for the feed or entry.
  */

attribute nsIURI link;

pub unsafe fn SetLink(&self, aLink: *const nsIURI) -> nsresult

/**
  * Returns the primary link for the feed or entry.
  */

attribute nsIURI link;

pub unsafe fn GetLinks(&self, aLinks: *mut *const nsIArray) -> nsresult

/**
  * Returns all links for a feed or entry.
  */

attribute nsIArray links;

pub unsafe fn SetLinks(&self, aLinks: *const nsIArray) -> nsresult

/**
  * Returns all links for a feed or entry.
  */

attribute nsIArray links;

pub unsafe fn GetCategories(
    &self,
    aCategories: *mut *const nsIArray
) -> nsresult

/**
  * Returns the categories found in a feed or entry.
  */

attribute nsIArray categories;

pub unsafe fn SetCategories(&self, aCategories: *const nsIArray) -> nsresult

/**
  * Returns the categories found in a feed or entry.
  */

attribute nsIArray categories;

pub unsafe fn GetRights(
    &self,
    aRights: *mut *const nsIFeedTextConstruct
) -> nsresult

/**
   * The rights or license associated with a feed or entry.
   */

attribute nsIFeedTextConstruct rights;

pub unsafe fn SetRights(&self, aRights: *const nsIFeedTextConstruct) -> nsresult

/**
   * The rights or license associated with a feed or entry.
   */

attribute nsIFeedTextConstruct rights;

pub unsafe fn GetAuthors(&self, aAuthors: *mut *const nsIArray) -> nsresult

/**
   * A list of nsIFeedPersons that authored the feed.
   */

attribute nsIArray authors;

pub unsafe fn SetAuthors(&self, aAuthors: *const nsIArray) -> nsresult

/**
   * A list of nsIFeedPersons that authored the feed.
   */

attribute nsIArray authors;

pub unsafe fn GetContributors(
    &self,
    aContributors: *mut *const nsIArray
) -> nsresult

/**
   * A list of nsIFeedPersons that contributed to the feed.
   */

attribute nsIArray contributors;

pub unsafe fn SetContributors(&self, aContributors: *const nsIArray) -> nsresult

/**
   * A list of nsIFeedPersons that contributed to the feed.
   */

attribute nsIArray contributors;

pub unsafe fn GetUpdated(&self, aUpdated: &mut nsAString) -> nsresult

/**
   * The date the feed was updated, in RFC822 form. Parsable by JS
   * and mail code.
   */

attribute AString updated;

pub unsafe fn SetUpdated(&self, aUpdated: &nsAString) -> nsresult

/**
   * The date the feed was updated, in RFC822 form. Parsable by JS
   * and mail code.
   */

attribute AString updated;

pub unsafe fn Normalize(&self) -> nsresult

/**
  * Syncs a container's fields with its convenience attributes.
  */

void normalize ();

Trait Implementations

impl XpCom for nsIFeed

const IID: nsIID

IID: nsIID = nsID(998944307, 32994, 20218, [153, 200, 166, 197, 185, 159, 118, 234])

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 nsIFeed

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIFeed

type Target = nsIFeedContainer

The resulting type after dereferencing.

fn deref(&self) -> &nsIFeedContainer

Dereferences the value.