Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/resistfingerprinting/nsIRFPService.idl
//
/// `interface nsIRFPService : nsISupports`
///
/// ```text
/// /**
/// * The singleton serivce which handles fingerprinting protection stuffs.
/// */
/// ```
///
// 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 nsIRFPService {
vtable: &'static nsIRFPServiceVTable,
/// 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 nsIRFPService.
unsafe impl XpCom for nsIRFPService {
const IID: nsIID = nsID(0x20093b2e, 0xd5d5, 0x4ce0,
[0x83, 0x55, 0x96, 0xb8, 0xd2, 0xdc, 0x7f, 0xf5]);
}
// 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 nsIRFPService {
#[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 nsIRFPService.
// 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 nsIRFPServiceCoerce {
/// Cheaply cast a value of this type from a `nsIRFPService`.
fn coerce_from(v: &nsIRFPService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIRFPServiceCoerce for nsIRFPService {
#[inline]
fn coerce_from(v: &nsIRFPService) -> &Self {
v
}
}
impl nsIRFPService {
/// Cast this `nsIRFPService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIRFPServiceCoerce>(&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 nsIRFPService {
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> nsIRFPServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsIRFPService) -> &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 nsIRFPService
// 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 nsIRFPServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void setFingerprintingOverrides (in Array<nsIFingerprintingOverride> aOverrides); */
pub SetFingerprintingOverrides: unsafe extern "system" fn (this: *const nsIRFPService, aOverrides: *const thin_vec::ThinVec<Option<RefPtr<nsIFingerprintingOverride>>>) -> ::nserror::nsresult,
/* uint64_t getFingerprintingOverrides (in ACString aDomainKey); */
pub GetFingerprintingOverrides: unsafe extern "system" fn (this: *const nsIRFPService, aDomainKey: *const ::nsstring::nsACString, _retval: *mut u64) -> ::nserror::nsresult,
/* void cleanAllOverrides (); */
pub CleanAllOverrides: unsafe extern "system" fn (this: *const nsIRFPService) -> ::nserror::nsresult,
/* readonly attribute uint64_t enabledFingerprintingProtections; */
pub GetEnabledFingerprintingProtections: unsafe extern "system" fn (this: *const nsIRFPService, aEnabledFingerprintingProtections: *mut u64) -> ::nserror::nsresult,
/* void cleanAllRandomKeys (); */
pub CleanAllRandomKeys: unsafe extern "system" fn (this: *const nsIRFPService) -> ::nserror::nsresult,
/* void cleanRandomKeyByPrincipal (in nsIPrincipal aPrincipal); */
pub CleanRandomKeyByPrincipal: unsafe extern "system" fn (this: *const nsIRFPService, aPrincipal: *const nsIPrincipal) -> ::nserror::nsresult,
/* void cleanRandomKeyByDomain (in ACString aDomain); */
pub CleanRandomKeyByDomain: unsafe extern "system" fn (this: *const nsIRFPService, aDomain: *const ::nsstring::nsACString) -> ::nserror::nsresult,
/* void cleanRandomKeyByHost (in ACString aHost, in AString aPattern); */
pub CleanRandomKeyByHost: unsafe extern "system" fn (this: *const nsIRFPService, aHost: *const ::nsstring::nsACString, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void cleanRandomKeyByOriginAttributesPattern (in AString aPattern); */
pub CleanRandomKeyByOriginAttributesPattern: unsafe extern "system" fn (this: *const nsIRFPService, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* Array<uint8_t> testGenerateRandomKey (in nsIChannel aChannel); */
pub TestGenerateRandomKey: unsafe extern "system" fn (this: *const nsIRFPService, aChannel: *const nsIChannel, _retval: *mut thin_vec::ThinVec<u8>) -> ::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 nsIRFPService {
/// ```text
/// /**
/// * Set the fingerprinting overrides.
/// *
/// * @param aOverrides
/// * An array of fingerprinting overrides.
/// */
/// ```
///
/// `void setFingerprintingOverrides (in Array<nsIFingerprintingOverride> aOverrides);`
#[inline]
pub unsafe fn SetFingerprintingOverrides(&self, aOverrides: *const thin_vec::ThinVec<Option<RefPtr<nsIFingerprintingOverride>>>) -> ::nserror::nsresult {
((*self.vtable).SetFingerprintingOverrides)(self, aOverrides)
}
/// ```text
/// /**
/// * Get the fingerprinting overrides of the given scope. This is for testing
/// * purpose.
/// *
/// * @param aScope
/// * The scope of the fingerprinting override.
/// * @return The RFPTarget flags for the fingerprinting overrides of the given
/// * scope. 0 if the overridden scope doesn't exist.
/// *
/// */
/// ```
///
/// `uint64_t getFingerprintingOverrides (in ACString aDomainKey);`
#[inline]
pub unsafe fn GetFingerprintingOverrides(&self, aDomainKey: *const ::nsstring::nsACString, _retval: *mut u64) -> ::nserror::nsresult {
((*self.vtable).GetFingerprintingOverrides)(self, aDomainKey, _retval)
}
/// ```text
/// /**
/// * Clean all overrides. This is for testing purpose.
/// */
/// ```
///
/// `void cleanAllOverrides ();`
#[inline]
pub unsafe fn CleanAllOverrides(&self, ) -> ::nserror::nsresult {
((*self.vtable).CleanAllOverrides)(self, )
}
/// ```text
/// /**
/// * The bitfield of the default enabled RFP Targets.
/// */
/// ```
///
/// `readonly attribute uint64_t enabledFingerprintingProtections;`
#[inline]
pub unsafe fn GetEnabledFingerprintingProtections(&self, aEnabledFingerprintingProtections: *mut u64) -> ::nserror::nsresult {
((*self.vtable).GetEnabledFingerprintingProtections)(self, aEnabledFingerprintingProtections)
}
/// ```text
/// /**
/// * Clean all fingerprinting randomization keys.
/// */
/// ```
///
/// `void cleanAllRandomKeys ();`
#[inline]
pub unsafe fn CleanAllRandomKeys(&self, ) -> ::nserror::nsresult {
((*self.vtable).CleanAllRandomKeys)(self, )
}
/// ```text
/// /**
/// * Clean the fingerprinting randomization key by the given principal.
/// */
/// ```
///
/// `void cleanRandomKeyByPrincipal (in nsIPrincipal aPrincipal);`
#[inline]
pub unsafe fn CleanRandomKeyByPrincipal(&self, aPrincipal: *const nsIPrincipal) -> ::nserror::nsresult {
((*self.vtable).CleanRandomKeyByPrincipal)(self, aPrincipal)
}
/// ```text
/// /**
/// * Clean the fingerprinting randomization key by the given domain.
/// */
/// ```
///
/// `void cleanRandomKeyByDomain (in ACString aDomain);`
#[inline]
pub unsafe fn CleanRandomKeyByDomain(&self, aDomain: *const ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).CleanRandomKeyByDomain)(self, aDomain)
}
/// ```text
/// /**
/// * Clean the fingerprinting randomization key by the given host and
/// * OriginAttributesPattern.
/// */
/// ```
///
/// `void cleanRandomKeyByHost (in ACString aHost, in AString aPattern);`
#[inline]
pub unsafe fn CleanRandomKeyByHost(&self, aHost: *const ::nsstring::nsACString, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).CleanRandomKeyByHost)(self, aHost, aPattern)
}
/// ```text
/// /**
/// * Clean the fingerprinting randomization key by the given
/// * OriginAttributesPattern.
/// */
/// ```
///
/// `void cleanRandomKeyByOriginAttributesPattern (in AString aPattern);`
#[inline]
pub unsafe fn CleanRandomKeyByOriginAttributesPattern(&self, aPattern: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).CleanRandomKeyByOriginAttributesPattern)(self, aPattern)
}
/// ```text
/// /**
/// * Test function for generating and return the fingerprinting randomization
/// * key for the given channel.
/// */
/// ```
///
/// `Array<uint8_t> testGenerateRandomKey (in nsIChannel aChannel);`
#[inline]
pub unsafe fn TestGenerateRandomKey(&self, aChannel: *const nsIChannel, _retval: *mut thin_vec::ThinVec<u8>) -> ::nserror::nsresult {
((*self.vtable).TestGenerateRandomKey)(self, aChannel, _retval)
}
}