Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/antitracking/bouncetrackingprotection/nsIBounceTrackingProtection.idl
//
/// `interface nsIBounceTrackingProtection : 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 nsIBounceTrackingProtection {
vtable: &'static nsIBounceTrackingProtectionVTable,
/// 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 nsIBounceTrackingProtection.
unsafe impl XpCom for nsIBounceTrackingProtection {
const IID: nsIID = nsID(0x4866f748, 0x29da, 0x4c10,
[0x8e, 0xaa, 0xed, 0x2f, 0x78, 0x51, 0xe6, 0xb1]);
}
// 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 nsIBounceTrackingProtection {
#[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 nsIBounceTrackingProtection.
// 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 nsIBounceTrackingProtectionCoerce {
/// Cheaply cast a value of this type from a `nsIBounceTrackingProtection`.
fn coerce_from(v: &nsIBounceTrackingProtection) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIBounceTrackingProtectionCoerce for nsIBounceTrackingProtection {
#[inline]
fn coerce_from(v: &nsIBounceTrackingProtection) -> &Self {
v
}
}
impl nsIBounceTrackingProtection {
/// Cast this `nsIBounceTrackingProtection` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIBounceTrackingProtectionCoerce>(&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 nsIBounceTrackingProtection {
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> nsIBounceTrackingProtectionCoerce for T {
#[inline]
fn coerce_from(v: &nsIBounceTrackingProtection) -> &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 nsIBounceTrackingProtection
// 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 nsIBounceTrackingProtectionVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void clearAll (); */
pub ClearAll: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection) -> ::nserror::nsresult,
/* [implicit_jscontext] void clearBySiteHostAndOriginAttributes (in ACString aSiteHost, in jsval originAttributes); */
/// Unable to generate binding because `special type jsval unsupported`
pub ClearBySiteHostAndOriginAttributes: *const ::libc::c_void,
/* [implicit_jscontext] void clearBySiteHostAndOriginAttributesPattern (in ACString aSiteHost, in jsval aOriginAttributesPattern); */
/// Unable to generate binding because `special type jsval unsupported`
pub ClearBySiteHostAndOriginAttributesPattern: *const ::libc::c_void,
/* void clearByTimeRange (in PRTime aFrom, in PRTime aTo); */
pub ClearByTimeRange: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection, aFrom: PRTime, aTo: PRTime) -> ::nserror::nsresult,
/* void clearByOriginAttributesPattern (in AString aPattern); */
pub ClearByOriginAttributesPattern: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void addSiteHostExceptions (in Array<ACString> aSiteHosts); */
pub AddSiteHostExceptions: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection, aSiteHosts: *const thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult,
/* void removeSiteHostExceptions (in Array<ACString> aSiteHosts); */
pub RemoveSiteHostExceptions: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection, aSiteHosts: *const thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult,
/* Array<ACString> testGetSiteHostExceptions (); */
pub TestGetSiteHostExceptions: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection, _retval: *mut thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult,
/* [implicit_jscontext] Promise testRunPurgeBounceTrackers (); */
/// Unable to generate binding because `jscontext is unsupported`
pub TestRunPurgeBounceTrackers: *const ::libc::c_void,
/* void testClearExpiredUserActivations (); */
pub TestClearExpiredUserActivations: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection) -> ::nserror::nsresult,
/* [implicit_jscontext] Array<nsIBounceTrackingMapEntry> testGetBounceTrackerCandidateHosts (in jsval originAttributes); */
/// Unable to generate binding because `special type jsval unsupported`
pub TestGetBounceTrackerCandidateHosts: *const ::libc::c_void,
/* [implicit_jscontext] Array<nsIBounceTrackingMapEntry> testGetUserActivationHosts (in jsval originAttributes); */
/// Unable to generate binding because `special type jsval unsupported`
pub TestGetUserActivationHosts: *const ::libc::c_void,
/* [implicit_jscontext] void testAddBounceTrackerCandidate (in jsval originAttributes, in ACString aSiteHost, in PRTime aBounceTime); */
/// Unable to generate binding because `special type jsval unsupported`
pub TestAddBounceTrackerCandidate: *const ::libc::c_void,
/* [implicit_jscontext] void testAddUserActivation (in jsval originAttributes, in ACString aSiteHost, in PRTime aActivationTime); */
/// Unable to generate binding because `special type jsval unsupported`
pub TestAddUserActivation: *const ::libc::c_void,
/* void testMaybeMigrateUserInteractionPermissions (); */
pub TestMaybeMigrateUserInteractionPermissions: unsafe extern "system" fn (this: *const nsIBounceTrackingProtection) -> ::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 nsIBounceTrackingProtection {
pub const MODE_DISABLED: u8 = 0;
pub const MODE_ENABLED: u8 = 1;
pub const MODE_ENABLED_STANDBY: u8 = 2;
pub const MODE_ENABLED_DRY_RUN: u8 = 3;
pub const MAX_MODE_VALUE: u8 = 3;
/// `void clearAll ();`
#[inline]
pub unsafe fn ClearAll(&self, ) -> ::nserror::nsresult {
((*self.vtable).ClearAll)(self, )
}
/// `[implicit_jscontext] void clearBySiteHostAndOriginAttributes (in ACString aSiteHost, in jsval originAttributes);`
const _ClearBySiteHostAndOriginAttributes: () = ();
/// `[implicit_jscontext] void clearBySiteHostAndOriginAttributesPattern (in ACString aSiteHost, in jsval aOriginAttributesPattern);`
const _ClearBySiteHostAndOriginAttributesPattern: () = ();
/// `void clearByTimeRange (in PRTime aFrom, in PRTime aTo);`
#[inline]
pub unsafe fn ClearByTimeRange(&self, aFrom: PRTime, aTo: PRTime) -> ::nserror::nsresult {
((*self.vtable).ClearByTimeRange)(self, aFrom, aTo)
}
/// `void clearByOriginAttributesPattern (in AString aPattern);`
#[inline]
pub unsafe fn ClearByOriginAttributesPattern(&self, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).ClearByOriginAttributesPattern)(self, aPattern)
}
/// `void addSiteHostExceptions (in Array<ACString> aSiteHosts);`
#[inline]
pub unsafe fn AddSiteHostExceptions(&self, aSiteHosts: *const thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult {
((*self.vtable).AddSiteHostExceptions)(self, aSiteHosts)
}
/// `void removeSiteHostExceptions (in Array<ACString> aSiteHosts);`
#[inline]
pub unsafe fn RemoveSiteHostExceptions(&self, aSiteHosts: *const thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult {
((*self.vtable).RemoveSiteHostExceptions)(self, aSiteHosts)
}
/// `Array<ACString> testGetSiteHostExceptions ();`
#[inline]
pub unsafe fn TestGetSiteHostExceptions(&self, _retval: *mut thin_vec::ThinVec<::nsstring::nsCString>) -> ::nserror::nsresult {
((*self.vtable).TestGetSiteHostExceptions)(self, _retval)
}
/// `[implicit_jscontext] Promise testRunPurgeBounceTrackers ();`
const _TestRunPurgeBounceTrackers: () = ();
/// `void testClearExpiredUserActivations ();`
#[inline]
pub unsafe fn TestClearExpiredUserActivations(&self, ) -> ::nserror::nsresult {
((*self.vtable).TestClearExpiredUserActivations)(self, )
}
/// `[implicit_jscontext] Array<nsIBounceTrackingMapEntry> testGetBounceTrackerCandidateHosts (in jsval originAttributes);`
const _TestGetBounceTrackerCandidateHosts: () = ();
/// `[implicit_jscontext] Array<nsIBounceTrackingMapEntry> testGetUserActivationHosts (in jsval originAttributes);`
const _TestGetUserActivationHosts: () = ();
/// `[implicit_jscontext] void testAddBounceTrackerCandidate (in jsval originAttributes, in ACString aSiteHost, in PRTime aBounceTime);`
const _TestAddBounceTrackerCandidate: () = ();
/// `[implicit_jscontext] void testAddUserActivation (in jsval originAttributes, in ACString aSiteHost, in PRTime aActivationTime);`
const _TestAddUserActivation: () = ();
/// `void testMaybeMigrateUserInteractionPermissions ();`
#[inline]
pub unsafe fn TestMaybeMigrateUserInteractionPermissions(&self, ) -> ::nserror::nsresult {
((*self.vtable).TestMaybeMigrateUserInteractionPermissions)(self, )
}
}