Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/cookiebanners/nsIClickRule.idl
//
/// `interface nsIClickRule : 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 nsIClickRule {
vtable: &'static nsIClickRuleVTable,
/// 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 nsIClickRule.
unsafe impl XpCom for nsIClickRule {
const IID: nsIID = nsID(0x7e104b32, 0xb6db, 0x43f3,
[0xb8, 0x87, 0x57, 0x3c, 0x01, 0xac, 0xef, 0x39]);
}
// 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 nsIClickRule {
#[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 nsIClickRule.
// 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 nsIClickRuleCoerce {
/// Cheaply cast a value of this type from a `nsIClickRule`.
fn coerce_from(v: &nsIClickRule) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIClickRuleCoerce for nsIClickRule {
#[inline]
fn coerce_from(v: &nsIClickRule) -> &Self {
v
}
}
impl nsIClickRule {
/// Cast this `nsIClickRule` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIClickRuleCoerce>(&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 nsIClickRule {
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> nsIClickRuleCoerce for T {
#[inline]
fn coerce_from(v: &nsIClickRule) -> &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 nsIClickRule
// 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 nsIClickRuleVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* [must_use] readonly attribute ACString id; */
pub GetId: unsafe extern "system" fn (this: *const nsIClickRule, aId: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute ACString presence; */
pub GetPresence: unsafe extern "system" fn (this: *const nsIClickRule, aPresence: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute boolean skipPresenceVisibilityCheck; */
pub GetSkipPresenceVisibilityCheck: unsafe extern "system" fn (this: *const nsIClickRule, aSkipPresenceVisibilityCheck: *mut bool) -> ::nserror::nsresult,
/* [must_use] readonly attribute nsIClickRule_RunContext runContext; */
pub GetRunContext: unsafe extern "system" fn (this: *const nsIClickRule, aRunContext: *mut u8) -> ::nserror::nsresult,
/* [must_use] readonly attribute ACString hide; */
pub GetHide: unsafe extern "system" fn (this: *const nsIClickRule, aHide: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute ACString optOut; */
pub GetOptOut: unsafe extern "system" fn (this: *const nsIClickRule, aOptOut: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute ACString optIn; */
pub GetOptIn: unsafe extern "system" fn (this: *const nsIClickRule, aOptIn: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute boolean isGlobalRule; */
pub GetIsGlobalRule: unsafe extern "system" fn (this: *const nsIClickRule, aIsGlobalRule: *mut bool) -> ::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 nsIClickRule {
pub const RUN_TOP: u8 = 0;
pub const RUN_CHILD: u8 = 1;
pub const RUN_ALL: u8 = 2;
/// ```text
/// /**
/// * The id for the click rule. For a global rule, the id will be the name of
/// * the CMP. For a per-site rule, the id would be a UUID string. This is the
/// * same id as the nsICookieBannerRule.
/// */
/// ```
///
/// `[must_use] readonly attribute ACString id;`
#[inline]
pub unsafe fn GetId(&self, aId: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetId)(self, aId)
}
/// ```text
/// /**
/// * The CSS selector for detecting the presence of the cookie banner.
/// */
/// ```
///
/// `[must_use] readonly attribute ACString presence;`
#[inline]
pub unsafe fn GetPresence(&self, aPresence: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetPresence)(self, aPresence)
}
/// ```text
/// /**
/// * Whether to skip checking if the banner is visible before clicking it.
/// */
/// ```
///
/// `[must_use] readonly attribute boolean skipPresenceVisibilityCheck;`
#[inline]
pub unsafe fn GetSkipPresenceVisibilityCheck(&self, aSkipPresenceVisibilityCheck: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetSkipPresenceVisibilityCheck)(self, aSkipPresenceVisibilityCheck)
}
/// ```text
/// /**
/// * Where the click rule should be executed. See RunContext enum. Defaults to
/// * RUN_TOP.
/// */
/// ```
///
/// `[must_use] readonly attribute nsIClickRule_RunContext runContext;`
#[inline]
pub unsafe fn GetRunContext(&self, aRunContext: *mut u8) -> ::nserror::nsresult {
((*self.vtable).GetRunContext)(self, aRunContext)
}
/// ```text
/// /**
/// * The CSS selector for hiding the presence of the cookie banner. If this is
/// * not given, we will use the presence selector to hide the banner.
/// *
/// * Note that we hide the cookie banner before we click it in order to prevent
/// * flickers.
/// */
/// ```
///
/// `[must_use] readonly attribute ACString hide;`
#[inline]
pub unsafe fn GetHide(&self, aHide: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetHide)(self, aHide)
}
/// ```text
/// /**
/// * The CSS selector to to select the element to click for the opt-out option
/// * for the cookie banner.
/// */
/// ```
///
/// `[must_use] readonly attribute ACString optOut;`
#[inline]
pub unsafe fn GetOptOut(&self, aOptOut: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetOptOut)(self, aOptOut)
}
/// ```text
/// /**
/// * The CSS selector to to select the element to click for the opt-in option
/// * for the cookie banner.
/// */
/// ```
///
/// `[must_use] readonly attribute ACString optIn;`
#[inline]
pub unsafe fn GetOptIn(&self, aOptIn: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetOptIn)(self, aOptIn)
}
/// ```text
/// /**
/// * Whether or not this click rule is a global rule.
/// */
/// ```
///
/// `[must_use] readonly attribute boolean isGlobalRule;`
#[inline]
pub unsafe fn GetIsGlobalRule(&self, aIsGlobalRule: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetIsGlobalRule)(self, aIsGlobalRule)
}
}