Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/glean/xpcom/nsIGleanPing.idl
//
/// `interface nsIGleanPingTestCallback : nsISupports`
///
// 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 nsIGleanPingTestCallback {
vtable: &'static nsIGleanPingTestCallbackVTable,
/// 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 nsIGleanPingTestCallback.
unsafe impl XpCom for nsIGleanPingTestCallback {
const IID: nsIID = nsID(0xe5447f62, 0x4b03, 0x497c,
[0x81, 0xe9, 0x6a, 0xb6, 0x83, 0xd2, 0x03, 0x80]);
}
// 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 nsIGleanPingTestCallback {
#[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 nsIGleanPingTestCallback.
// 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 nsIGleanPingTestCallbackCoerce {
/// Cheaply cast a value of this type from a `nsIGleanPingTestCallback`.
fn coerce_from(v: &nsIGleanPingTestCallback) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIGleanPingTestCallbackCoerce for nsIGleanPingTestCallback {
#[inline]
fn coerce_from(v: &nsIGleanPingTestCallback) -> &Self {
v
}
}
impl nsIGleanPingTestCallback {
/// Cast this `nsIGleanPingTestCallback` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIGleanPingTestCallbackCoerce>(&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 nsIGleanPingTestCallback {
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> nsIGleanPingTestCallbackCoerce for T {
#[inline]
fn coerce_from(v: &nsIGleanPingTestCallback) -> &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 nsIGleanPingTestCallback
// 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 nsIGleanPingTestCallbackVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void call (in ACString aReason); */
pub Call: unsafe extern "system" fn (this: *const nsIGleanPingTestCallback, aReason: *const ::nsstring::nsACString) -> ::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 nsIGleanPingTestCallback {
/// `void call (in ACString aReason);`
#[inline]
pub unsafe fn Call(&self, aReason: *const ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).Call)(self, aReason)
}
}
/// `interface nsIGleanPing : nsISupports`
///
// 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 nsIGleanPing {
vtable: &'static nsIGleanPingVTable,
/// 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 nsIGleanPing.
unsafe impl XpCom for nsIGleanPing {
const IID: nsIID = nsID(0x5223a48b, 0x687d, 0x47ff,
[0xa6, 0x29, 0xfd, 0x4a, 0x72, 0xd1, 0xec, 0xfa]);
}
// 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 nsIGleanPing {
#[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 nsIGleanPing.
// 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 nsIGleanPingCoerce {
/// Cheaply cast a value of this type from a `nsIGleanPing`.
fn coerce_from(v: &nsIGleanPing) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIGleanPingCoerce for nsIGleanPing {
#[inline]
fn coerce_from(v: &nsIGleanPing) -> &Self {
v
}
}
impl nsIGleanPing {
/// Cast this `nsIGleanPing` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIGleanPingCoerce>(&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 nsIGleanPing {
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> nsIGleanPingCoerce for T {
#[inline]
fn coerce_from(v: &nsIGleanPing) -> &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 nsIGleanPing
// 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 nsIGleanPingVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void submit ([optional] in ACString aReason); */
pub Submit: unsafe extern "system" fn (this: *const nsIGleanPing, aReason: *const ::nsstring::nsACString) -> ::nserror::nsresult,
/* void testBeforeNextSubmit (in nsIGleanPingTestCallback aCallback); */
pub TestBeforeNextSubmit: unsafe extern "system" fn (this: *const nsIGleanPing, aCallback: *const nsIGleanPingTestCallback) -> ::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 nsIGleanPing {
/// ```text
/// /**
/// * Collect and submit the ping for eventual upload.
/// *
/// * This will collect all stored data to be included in the ping.
/// * Data with lifetime `ping` will then be reset.
/// *
/// * If the ping is configured with `send_if_empty = false`
/// * and the ping currently contains no content,
/// * it will not be queued for upload.
/// * If the ping is configured with `send_if_empty = true`
/// * it will be queued for upload even if empty.
/// *
/// * Pings always contain the `ping_info` and `client_info` sections.
/// * for details.
/// *
/// * @param aReason - Optional. The reason the ping is being submitted.
/// * Must match one of the configured `reason_codes`.
/// */
/// ```
///
/// `void submit ([optional] in ACString aReason);`
#[inline]
pub unsafe fn Submit(&self, aReason: *const ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).Submit)(self, aReason)
}
/// ```text
/// /**
/// * **Test-only API**
/// *
/// * Register a callback to be called right before this ping is next submitted.
/// * The provided function is called exactly once before submitting.
/// *
/// * Note: The callback will be called on any call to submit.
/// * A ping might not be sent afterwards, e.g. if the ping is empty and
/// * `send_if_empty` is `false`.
/// *
/// * @param aCallback - The callback to call on the next submit.
/// */
/// ```
///
/// `void testBeforeNextSubmit (in nsIGleanPingTestCallback aCallback);`
#[inline]
pub unsafe fn TestBeforeNextSubmit(&self, aCallback: *const nsIGleanPingTestCallback) -> ::nserror::nsresult {
((*self.vtable).TestBeforeNextSubmit)(self, aCallback)
}
}