Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/antitracking/nsIURLQueryStringStripper.idl
//
/// `interface nsIURLQueryStringStripper : nsISupports`
///
/// ```text
/// /**
/// * nsIURLQueryStringStripper is responsible for stripping certain part of the
/// * query string of the given URI to address the bounce(redirect) tracking
/// * issues. It will strip every query parameter which matches the strip list
/// * defined in the pref 'privacy.query_stripping.strip_list'. Note that It's
/// * different from URLDecorationStripper which strips the entire query string
/// * from the referrer if there is a tracking query parameter present in the URI.
/// *
/// * TODO: Given that nsIURLQueryStringStripper and URLDecorationStripper are
/// * doing similar things. We could somehow combine these two modules into
/// * one. We will improve this in the future.
/// */
/// ```
///
// 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 nsIURLQueryStringStripper {
vtable: &'static nsIURLQueryStringStripperVTable,
/// 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 nsIURLQueryStringStripper.
unsafe impl XpCom for nsIURLQueryStringStripper {
const IID: nsIID = nsID(0x6b42a890, 0x2624, 0x4560,
[0x99, 0xc4, 0xb2, 0x53, 0x80, 0xe8, 0xcd, 0x77]);
}
// 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 nsIURLQueryStringStripper {
#[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 nsIURLQueryStringStripper.
// 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 nsIURLQueryStringStripperCoerce {
/// Cheaply cast a value of this type from a `nsIURLQueryStringStripper`.
fn coerce_from(v: &nsIURLQueryStringStripper) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIURLQueryStringStripperCoerce for nsIURLQueryStringStripper {
#[inline]
fn coerce_from(v: &nsIURLQueryStringStripper) -> &Self {
v
}
}
impl nsIURLQueryStringStripper {
/// Cast this `nsIURLQueryStringStripper` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIURLQueryStringStripperCoerce>(&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 nsIURLQueryStringStripper {
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> nsIURLQueryStringStripperCoerce for T {
#[inline]
fn coerce_from(v: &nsIURLQueryStringStripper) -> &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 nsIURLQueryStringStripper
// 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 nsIURLQueryStringStripperVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* uint32_t strip (in nsIURI aURI, in boolean aIsPBM, out nsIURI aOutput); */
pub Strip: unsafe extern "system" fn (this: *const nsIURLQueryStringStripper, aURI: *const nsIURI, aIsPBM: bool, aOutput: *mut *const nsIURI, _retval: *mut u32) -> ::nserror::nsresult,
/* [must_use] nsIURI stripForCopyOrShare (in nsIURI aURI); */
pub StripForCopyOrShare: unsafe extern "system" fn (this: *const nsIURLQueryStringStripper, aURI: *const nsIURI, _retval: *mut *const nsIURI) -> ::nserror::nsresult,
/* ACString testGetStripList (); */
pub TestGetStripList: unsafe extern "system" fn (this: *const nsIURLQueryStringStripper, _retval: *mut ::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 nsIURLQueryStringStripper {
/// `uint32_t strip (in nsIURI aURI, in boolean aIsPBM, out nsIURI aOutput);`
#[inline]
pub unsafe fn Strip(&self, aURI: *const nsIURI, aIsPBM: bool, aOutput: *mut *const nsIURI, _retval: *mut u32) -> ::nserror::nsresult {
((*self.vtable).Strip)(self, aURI, aIsPBM, aOutput, _retval)
}
/// `[must_use] nsIURI stripForCopyOrShare (in nsIURI aURI);`
#[inline]
pub unsafe fn StripForCopyOrShare(&self, aURI: *const nsIURI, _retval: *mut *const nsIURI) -> ::nserror::nsresult {
((*self.vtable).StripForCopyOrShare)(self, aURI, _retval)
}
/// `ACString testGetStripList ();`
#[inline]
pub unsafe fn TestGetStripList(&self, _retval: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).TestGetStripList)(self, _retval)
}
}