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


/// `interface nsIDownloadHistory : nsISupports`
///

/// ```text
/// /**
///  * This interface can be used to add a download to history.  There is a separate
///  * interface specifically for downloads in case embedders choose to track
///  * downloads differently from other types of history.
///  */
/// ```
///

// 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 nsIDownloadHistory {
    vtable: *const nsIDownloadHistoryVTable,

    /// 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 nsIDownloadHistory.
unsafe impl XpCom for nsIDownloadHistory {
    const IID: nsIID = nsID(0x4dcd6a12, 0xa091, 0x4f38,
        [0x83, 0x60, 0x02, 0x29, 0x29, 0x63, 0x57, 0x46]);
}

// 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 nsIDownloadHistory {
    #[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 nsIDownloadHistory.
// 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 nsIDownloadHistoryCoerce {
    /// Cheaply cast a value of this type from a `nsIDownloadHistory`.
    fn coerce_from(v: &nsIDownloadHistory) -> &Self;
}

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

impl nsIDownloadHistory {
    /// Cast this `nsIDownloadHistory` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIDownloadHistoryCoerce>(&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 nsIDownloadHistory {
    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> nsIDownloadHistoryCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIDownloadHistory) -> &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 nsIDownloadHistory
// 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 nsIDownloadHistoryVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* void addDownload (in nsIURI aSource, [optional] in nsIURI aReferrer, [optional] in PRTime aStartTime, [optional] in nsIURI aDestination); */
    pub AddDownload: unsafe extern "system" fn (this: *const nsIDownloadHistory, aSource: *const nsIURI, aReferrer: *const nsIURI, aStartTime: PRTime, aDestination: *const nsIURI) -> nsresult,

    /* void removeAllDownloads (); */
    pub RemoveAllDownloads: unsafe extern "system" fn (this: *const nsIDownloadHistory) -> 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 nsIDownloadHistory {

    /// ```text
    /// /**
    ///    * Adds a download to history.  This will also notify observers that the
    ///    * URI aSource is visited with the topic NS_LINK_VISITED_EVENT_TOPIC if
    ///    * aSource has not yet been visited.
    ///    *
    ///    * @param aSource
    ///    *        The source of the download we are adding to history.  This cannot be
    ///    *        null.
    ///    * @param aReferrer
    ///    *        [optional] The referrer of source URI.
    ///    * @param aStartTime
    ///    *        [optional] The time the download was started.  If the start time
    ///    *        is not given, the current time is used.
    ///    * @param aDestination
    ///    *        [optional] The target where the download is to be saved on the local
    ///    *        filesystem.
    ///    * @throws NS_ERROR_NOT_AVAILABLE
    ///    *         In a situation where a history implementation is not available,
    ///    *         where 'history implementation' refers to something like
    ///    *         nsIGlobalHistory and friends.
    ///    * @note This addition is not guaranteed to be synchronous, since it delegates
    ///    *       the actual addition to the underlying history implementation.  If you
    ///    *       need to observe the completion of the addition, use the underlying
    ///    *       history implementation's notifications system (e.g. nsINavHistoryObserver
        ///    *       for toolkit's implementation of this interface).
    ///    */
    /// ```
    ///

    /// `void addDownload (in nsIURI aSource, [optional] in nsIURI aReferrer, [optional] in PRTime aStartTime, [optional] in nsIURI aDestination);`
    #[inline]
    pub unsafe fn AddDownload(&self, aSource: *const nsIURI, aReferrer: *const nsIURI, aStartTime: PRTime, aDestination: *const nsIURI) -> nsresult {
        ((*self.vtable).AddDownload)(self, aSource, aReferrer, aStartTime, aDestination)
    }


    /// ```text
    /// /**
    ///    * Remove all downloads from history.
    ///    *
    ///    * @note This removal is not guaranteed to be synchronous, since it delegates
    ///    *       the actual removal to the underlying history implementation.  If you
    ///    *       need to observe the completion of the removal, use the underlying
    ///    *       history implementation's notifications system (e.g. nsINavHistoryObserver
        ///    *       for toolkit's implementation of this interface).
    ///    */
    /// ```
    ///

    /// `void removeAllDownloads ();`
    #[inline]
    pub unsafe fn RemoveAllDownloads(&self, ) -> nsresult {
        ((*self.vtable).RemoveAllDownloads)(self, )
    }


}