//
// DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/nsIFeedResult.idl
//


/// `interface nsIFeedResult : nsISupports`
///

/// ```text
/// /**
///  * The nsIFeedResult interface provides access to HTTP and parsing
///  * metadata for a feed or entry.
///  */
/// ```
///

// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.

#[repr(C)]
pub struct nsIFeedResult {
    vtable: *const nsIFeedResultVTable,

    /// This field is a phantomdata to ensure that the VTable type and any
    /// struct containing it is not safe to send across threads, as XPCOM is
    /// generally not threadsafe.
    ///
    /// XPCOM interfaces in general are not safe to send across threads.
    __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
}

// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsIFeedResult.
unsafe impl XpCom for nsIFeedResult {
    const IID: nsIID = nsID(0x7a180b78, 0x0f46, 0x4569,
        [0x8c, 0x22, 0xf3, 0xd7, 0x20, 0xea, 0x1c, 0x57]);
}

// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsIFeedResult {
    #[inline]
    unsafe fn addref(&self) {
        self.AddRef();
    }
    #[inline]
    unsafe fn release(&self) {
        self.Release();
    }
}

// This trait is implemented on all types which can be coerced to from nsIFeedResult.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsIFeedResultCoerce {
    /// Cheaply cast a value of this type from a `nsIFeedResult`.
    fn coerce_from(v: &nsIFeedResult) -> &Self;
}

// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIFeedResultCoerce for nsIFeedResult {
    #[inline]
    fn coerce_from(v: &nsIFeedResult) -> &Self {
        v
    }
}

impl nsIFeedResult {
    /// Cast this `nsIFeedResult` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIFeedResultCoerce>(&self) -> &T {
        T::coerce_from(self)
    }
}

// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsIFeedResult {
    type Target = nsISupports;
    #[inline]
    fn deref(&self) -> &nsISupports {
        unsafe {
            ::std::mem::transmute(self)
        }
    }
}

// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsISupportsCoerce> nsIFeedResultCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIFeedResult) -> &Self {
        T::coerce_from(v)
    }
}

// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsIFeedResult
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsIFeedResultVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* attribute boolean bozo; */
    pub GetBozo: unsafe extern "system" fn (this: *const nsIFeedResult, aBozo: *mut bool) -> nsresult,

    /* attribute boolean bozo; */
    pub SetBozo: unsafe extern "system" fn (this: *const nsIFeedResult, aBozo: bool) -> nsresult,

    /* attribute nsIFeedContainer doc; */
    pub GetDoc: unsafe extern "system" fn (this: *const nsIFeedResult, aDoc: *mut *const nsIFeedContainer) -> nsresult,

    /* attribute nsIFeedContainer doc; */
    pub SetDoc: unsafe extern "system" fn (this: *const nsIFeedResult, aDoc: *const nsIFeedContainer) -> nsresult,

    /* attribute nsIURI uri; */
    pub GetUri: unsafe extern "system" fn (this: *const nsIFeedResult, aUri: *mut *const nsIURI) -> nsresult,

    /* attribute nsIURI uri; */
    pub SetUri: unsafe extern "system" fn (this: *const nsIFeedResult, aUri: *const nsIURI) -> nsresult,

    /* attribute AString version; */
    pub GetVersion: unsafe extern "system" fn (this: *const nsIFeedResult, aVersion: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString version; */
    pub SetVersion: unsafe extern "system" fn (this: *const nsIFeedResult, aVersion: &::nsstring::nsAString) -> nsresult,

    /* attribute nsIURI stylesheet; */
    pub GetStylesheet: unsafe extern "system" fn (this: *const nsIFeedResult, aStylesheet: *mut *const nsIURI) -> nsresult,

    /* attribute nsIURI stylesheet; */
    pub SetStylesheet: unsafe extern "system" fn (this: *const nsIFeedResult, aStylesheet: *const nsIURI) -> nsresult,

    /* attribute nsIProperties headers; */
    pub GetHeaders: unsafe extern "system" fn (this: *const nsIFeedResult, aHeaders: *mut *const nsIProperties) -> nsresult,

    /* attribute nsIProperties headers; */
    pub SetHeaders: unsafe extern "system" fn (this: *const nsIFeedResult, aHeaders: *const nsIProperties) -> nsresult,

    /* void registerExtensionPrefix (in AString aNamespace, in AString aPrefix); */
    pub RegisterExtensionPrefix: unsafe extern "system" fn (this: *const nsIFeedResult, aNamespace: &::nsstring::nsAString, aPrefix: &::nsstring::nsAString) -> nsresult,
}


// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsIFeedResult {

    /// ```text
    /// /**
    ///   * The Feed parser will set the bozo bit when a feed triggers a fatal
    ///   * error during XML parsing. There may be entries and feed metadata
    ///   * that were parsed before the error.  Thanks to Tim Bray for
    ///   * suggesting this terminology.
    ///   * <http://www.tbray.org/ongoing/When/200x/2004/01/11/PostelPilgrim>
    ///   */
    /// ```
    ///

    /// `attribute boolean bozo;`
    #[inline]
    pub unsafe fn GetBozo(&self, aBozo: *mut bool) -> nsresult {
        ((*self.vtable).GetBozo)(self, aBozo)
    }


    /// ```text
    /// /**
    ///   * The Feed parser will set the bozo bit when a feed triggers a fatal
    ///   * error during XML parsing. There may be entries and feed metadata
    ///   * that were parsed before the error.  Thanks to Tim Bray for
    ///   * suggesting this terminology.
    ///   * <http://www.tbray.org/ongoing/When/200x/2004/01/11/PostelPilgrim>
    ///   */
    /// ```
    ///

    /// `attribute boolean bozo;`
    #[inline]
    pub unsafe fn SetBozo(&self, aBozo: bool) -> nsresult {
        ((*self.vtable).SetBozo)(self, aBozo)
    }


    /// ```text
    /// /**
    ///   * The parsed feed or entry.
    ///   *
    ///   * Will be null if a non-feed is processed.
    ///   */
    /// ```
    ///

    /// `attribute nsIFeedContainer doc;`
    #[inline]
    pub unsafe fn GetDoc(&self, aDoc: *mut *const nsIFeedContainer) -> nsresult {
        ((*self.vtable).GetDoc)(self, aDoc)
    }


    /// ```text
    /// /**
    ///   * The parsed feed or entry.
    ///   *
    ///   * Will be null if a non-feed is processed.
    ///   */
    /// ```
    ///

    /// `attribute nsIFeedContainer doc;`
    #[inline]
    pub unsafe fn SetDoc(&self, aDoc: *const nsIFeedContainer) -> nsresult {
        ((*self.vtable).SetDoc)(self, aDoc)
    }


    /// ```text
    /// /**
    ///   * The address from which the feed was fetched.
    ///   */
    /// ```
    ///

    /// `attribute nsIURI uri;`
    #[inline]
    pub unsafe fn GetUri(&self, aUri: *mut *const nsIURI) -> nsresult {
        ((*self.vtable).GetUri)(self, aUri)
    }


    /// ```text
    /// /**
    ///   * The address from which the feed was fetched.
    ///   */
    /// ```
    ///

    /// `attribute nsIURI uri;`
    #[inline]
    pub unsafe fn SetUri(&self, aUri: *const nsIURI) -> nsresult {
        ((*self.vtable).SetUri)(self, aUri)
    }


    /// ```text
    /// /**
    ///   * Feed Version:
    ///   * atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03,
    ///   * atomEntry, rssItem
    ///   *
    ///   * Will be null if a non-feed is processed.
    ///   */
    /// ```
    ///

    /// `attribute AString version;`
    #[inline]
    pub unsafe fn GetVersion(&self, aVersion: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetVersion)(self, aVersion)
    }


    /// ```text
    /// /**
    ///   * Feed Version:
    ///   * atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03,
    ///   * atomEntry, rssItem
    ///   *
    ///   * Will be null if a non-feed is processed.
    ///   */
    /// ```
    ///

    /// `attribute AString version;`
    #[inline]
    pub unsafe fn SetVersion(&self, aVersion: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetVersion)(self, aVersion)
    }


    /// ```text
    /// /**
    ///   * An XSLT stylesheet available to transform the source of the
    ///   * feed. Some feeds include this information in a processing
    ///   * instruction. It's generally intended for clients with specific
    ///   * feed capabilities.
    ///   */
    /// ```
    ///

    /// `attribute nsIURI stylesheet;`
    #[inline]
    pub unsafe fn GetStylesheet(&self, aStylesheet: *mut *const nsIURI) -> nsresult {
        ((*self.vtable).GetStylesheet)(self, aStylesheet)
    }


    /// ```text
    /// /**
    ///   * An XSLT stylesheet available to transform the source of the
    ///   * feed. Some feeds include this information in a processing
    ///   * instruction. It's generally intended for clients with specific
    ///   * feed capabilities.
    ///   */
    /// ```
    ///

    /// `attribute nsIURI stylesheet;`
    #[inline]
    pub unsafe fn SetStylesheet(&self, aStylesheet: *const nsIURI) -> nsresult {
        ((*self.vtable).SetStylesheet)(self, aStylesheet)
    }


    /// ```text
    /// /**
    ///   * HTTP response headers that accompanied the feed.
    ///   */
    /// ```
    ///

    /// `attribute nsIProperties headers;`
    #[inline]
    pub unsafe fn GetHeaders(&self, aHeaders: *mut *const nsIProperties) -> nsresult {
        ((*self.vtable).GetHeaders)(self, aHeaders)
    }


    /// ```text
    /// /**
    ///   * HTTP response headers that accompanied the feed.
    ///   */
    /// ```
    ///

    /// `attribute nsIProperties headers;`
    #[inline]
    pub unsafe fn SetHeaders(&self, aHeaders: *const nsIProperties) -> nsresult {
        ((*self.vtable).SetHeaders)(self, aHeaders)
    }


    /// ```text
    /// /**
    ///   * Registers a prefix used to access an extension in the feed/entry
    ///   */
    /// ```
    ///

    /// `void registerExtensionPrefix (in AString aNamespace, in AString aPrefix);`
    #[inline]
    pub unsafe fn RegisterExtensionPrefix(&self, aNamespace: &::nsstring::nsAString, aPrefix: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).RegisterExtensionPrefix)(self, aNamespace, aPrefix)
    }


}