Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/modules/libpref/nsIPrefOverrideMap.idl
//
/// `interface nsIPrefOverrideMap : nsISupports`
///
/// ```text
/// /**
/// * Represents a C++ map of pref names to values that is constructable from JS.
/// * The entries in this map must be known prefs and the type of the jsval
/// * values must match the known type of the pref. We currently use this to
/// * overlay alternative values atop the current pref values during
/// * backupPrefFile, for prefs that we don't want to back up, or that we do want
/// * to back up, but with values different than the current ones.
/// */
/// ```
///
// 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 nsIPrefOverrideMap {
vtable: &'static nsIPrefOverrideMapVTable,
/// 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 nsIPrefOverrideMap.
unsafe impl XpCom for nsIPrefOverrideMap {
const IID: nsIID = nsID(0x56ba17e3, 0x4bfd, 0x4804,
[0xbd, 0xf7, 0x9c, 0x6e, 0x70, 0x17, 0x02, 0x79]);
}
// 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 nsIPrefOverrideMap {
#[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 nsIPrefOverrideMap.
// 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 nsIPrefOverrideMapCoerce {
/// Cheaply cast a value of this type from a `nsIPrefOverrideMap`.
fn coerce_from(v: &nsIPrefOverrideMap) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIPrefOverrideMapCoerce for nsIPrefOverrideMap {
#[inline]
fn coerce_from(v: &nsIPrefOverrideMap) -> &Self {
v
}
}
impl nsIPrefOverrideMap {
/// Cast this `nsIPrefOverrideMap` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIPrefOverrideMapCoerce>(&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 nsIPrefOverrideMap {
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> nsIPrefOverrideMapCoerce for T {
#[inline]
fn coerce_from(v: &nsIPrefOverrideMap) -> &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 nsIPrefOverrideMap
// 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 nsIPrefOverrideMapVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* [implicit_jscontext] void addEntry (in ACString aPrefName, in jsval aPrefValue); */
/// Unable to generate binding because `special type jsval unsupported`
pub AddEntry: *const ::libc::c_void,
/* [implicit_jscontext] jsval getEntry (in ACString aPrefName); */
/// Unable to generate binding because `jscontext is unsupported`
pub GetEntry: *const ::libc::c_void,
}
// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsIPrefOverrideMap {
/// ```text
/// /**
/// * Add value to the map.
/// * @param aPrefName Must be a known pref.
/// * @param aPrefValue Type must be a boolean, an integer, or a string and must
/// * match the known type of the pref. Regardless of type,
/// * this can always be null.
/// * @throws If aPrefName is not a valid pref name, if aPrefValue is not of the
/// * right type for the pref, or on OOM
/// */
/// ```
///
/// `[implicit_jscontext] void addEntry (in ACString aPrefName, in jsval aPrefValue);`
const _AddEntry: () = ();
/// ```text
/// /**
/// * Retrieve a value from the map.
/// * @param aPrefName Must be a known pref.
/// * @returns A boolean, an integer, or a string.
/// * @throws If aPrefName is not in the map or on OOM.
/// */
/// ```
///
/// `[implicit_jscontext] jsval getEntry (in ACString aPrefName);`
const _GetEntry: () = ();
}