Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/netwerk/base/nsIThreadRetargetableStreamListener.idl
//
/// `interface nsIThreadRetargetableStreamListener : nsIStreamListener`
///
/// ```text
/// /**
/// * nsIThreadRetargetableStreamListener
/// *
/// * To be used by classes which implement nsIStreamListener and whose
/// * OnDataAvailable callback may be retargeted for delivery off the main thread.
/// */
/// ```
///
// 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 nsIThreadRetargetableStreamListener {
vtable: &'static nsIThreadRetargetableStreamListenerVTable,
/// This field is a phantomdata to ensure that the VTable type and any
/// struct containing it is not safe to send across threads by default, as
/// XPCOM is generally not threadsafe.
///
/// If this type is marked as [rust_sync], there will be explicit `Send` and
/// `Sync` implementations on this type, which will override the inherited
/// negative impls from `Rc`.
__nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
// Make the rust compiler aware that there might be interior mutability
// in what actually implements the interface. This works around UB
// introduced by https://github.com/llvm/llvm-project/commit/01859da84bad95fd51d6a03b08b60c660e642a4f
// that a rust lint would make blatantly obvious, but doesn't exist.
// This prevents optimizations, but those optimizations weren't available
// before rustc switched to LLVM 16, and they now cause problems because
// of the UB.
// Until there's a lint available to find all our UB, it's simpler to
// avoid the UB in the first place, at the cost of preventing optimizations
// in places that don't cause UB. But again, those optimizations weren't
// available before.
__maybe_interior_mutability: ::std::cell::UnsafeCell<[u8; 0]>,
}
// 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 nsIThreadRetargetableStreamListener.
unsafe impl XpCom for nsIThreadRetargetableStreamListener {
const IID: nsIID = nsID(0xfb2304b8, 0xf82f, 0x4433,
[0xaf, 0x68, 0xd8, 0x74, 0xa2, 0xeb, 0xbd, 0xc1]);
}
// 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 nsIThreadRetargetableStreamListener {
#[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 nsIThreadRetargetableStreamListener.
// 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 nsIThreadRetargetableStreamListenerCoerce {
/// Cheaply cast a value of this type from a `nsIThreadRetargetableStreamListener`.
fn coerce_from(v: &nsIThreadRetargetableStreamListener) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIThreadRetargetableStreamListenerCoerce for nsIThreadRetargetableStreamListener {
#[inline]
fn coerce_from(v: &nsIThreadRetargetableStreamListener) -> &Self {
v
}
}
impl nsIThreadRetargetableStreamListener {
/// Cast this `nsIThreadRetargetableStreamListener` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIThreadRetargetableStreamListenerCoerce>(&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 nsIThreadRetargetableStreamListener {
type Target = nsIStreamListener;
#[inline]
fn deref(&self) -> &nsIStreamListener {
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: nsIStreamListenerCoerce> nsIThreadRetargetableStreamListenerCoerce for T {
#[inline]
fn coerce_from(v: &nsIThreadRetargetableStreamListener) -> &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 nsIThreadRetargetableStreamListener
// 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 nsIThreadRetargetableStreamListenerVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsIStreamListenerVTable,
/* void checkListenerChain (); */
pub CheckListenerChain: unsafe extern "system" fn (this: *const nsIThreadRetargetableStreamListener) -> ::nserror::nsresult,
/* void onDataFinished (in nsresult aStatusCode); */
pub OnDataFinished: unsafe extern "system" fn (this: *const nsIThreadRetargetableStreamListener, aStatusCode: nserror::nsresult) -> ::nserror::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 nsIThreadRetargetableStreamListener {
/// ```text
/// /**
/// * Checks this listener and any next listeners it may have to verify that
/// * they can receive OnDataAvailable off the main thread. It is the
/// * responsibility of the implementing class to decide on the criteria to
/// * determine if retargeted delivery of these methods is possible, but it must
/// * check any and all nsIStreamListener objects that might be called in the
/// * listener chain.
/// *
/// * An exception should be thrown if a listener in the chain does not
/// * support retargeted delivery, i.e. if the next listener does not implement
/// * nsIThreadRetargetableStreamListener, or a call to its checkListenerChain()
/// * fails.
/// */
/// ```
///
/// `void checkListenerChain ();`
#[inline]
pub unsafe fn CheckListenerChain(&self, ) -> ::nserror::nsresult {
((*self.vtable).CheckListenerChain)(self, )
}
/// ```text
/// /**
/// * Used for notifying listeners about data stop.
/// * After this notification, the listeners could potentially start processing
/// * the data. Note that onDataFinished can be called on or off the main thread.
/// * It is the responsibility of the listeners to handle this correctly.
/// *
/// * The ChannelEventQueue implementation ensures that the OnDataFinished is
/// * run on the ODA target thread after the last OnDataAvailable is executed on
/// * the ODA target thread and before OnStopRequest is called.
/// * Hence, the following order is guaranteed for the listeners, even with ODA/ODF running off MainThread.
/// * 1. OnStartRequest
/// * 2. OnDataAvailable
/// * 3. OnDataFinished
/// * 4. OnStopRequest
/// */
/// ```
///
/// `void onDataFinished (in nsresult aStatusCode);`
#[inline]
pub unsafe fn OnDataFinished(&self, aStatusCode: nserror::nsresult) -> ::nserror::nsresult {
((*self.vtable).OnDataFinished)(self, aStatusCode)
}
}