Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/url-classifier/nsIUrlClassifierRemoteSettingsService.idl
//
/// `interface nsIUrlClassifierRemoteSettingsService : nsISupports`
///
/// ```text
/// /**
/// * A service that serves Safe Browsing list data (V2 protocol) via
/// * Remote Settings.
/// */
/// ```
///
// 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 nsIUrlClassifierRemoteSettingsService {
vtable: &'static nsIUrlClassifierRemoteSettingsServiceVTable,
/// 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 nsIUrlClassifierRemoteSettingsService.
unsafe impl XpCom for nsIUrlClassifierRemoteSettingsService {
const IID: nsIID = nsID(0x26a445a4, 0x0d00, 0x4b20,
[0xba, 0x5f, 0x12, 0x97, 0xd3, 0x34, 0x4a, 0x25]);
}
// 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 nsIUrlClassifierRemoteSettingsService {
#[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 nsIUrlClassifierRemoteSettingsService.
// 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 nsIUrlClassifierRemoteSettingsServiceCoerce {
/// Cheaply cast a value of this type from a `nsIUrlClassifierRemoteSettingsService`.
fn coerce_from(v: &nsIUrlClassifierRemoteSettingsService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIUrlClassifierRemoteSettingsServiceCoerce for nsIUrlClassifierRemoteSettingsService {
#[inline]
fn coerce_from(v: &nsIUrlClassifierRemoteSettingsService) -> &Self {
v
}
}
impl nsIUrlClassifierRemoteSettingsService {
/// Cast this `nsIUrlClassifierRemoteSettingsService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIUrlClassifierRemoteSettingsServiceCoerce>(&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 nsIUrlClassifierRemoteSettingsService {
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> nsIUrlClassifierRemoteSettingsServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsIUrlClassifierRemoteSettingsService) -> &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 nsIUrlClassifierRemoteSettingsService
// 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 nsIUrlClassifierRemoteSettingsServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void fetchList (in ACString aPayload, in nsIStreamListener aListener); */
pub FetchList: unsafe extern "system" fn (this: *const nsIUrlClassifierRemoteSettingsService, aPayload: *const ::nsstring::nsACString, aListener: *const nsIStreamListener) -> ::nserror::nsresult,
/* void clear (); */
pub Clear: unsafe extern "system" fn (this: *const nsIUrlClassifierRemoteSettingsService) -> ::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 nsIUrlClassifierRemoteSettingsService {
/// ```text
/// /**
/// * Fetch the Safe Browsing list data from the service. The service
/// * returns the response data by simulating how the data is sent over a
/// * stream listener when a HTTP request is made.
/// *
/// *
/// * @param aPayload the request payload for list data request
/// * @param aListener An nsIStreamListener object
/// */
/// ```
///
/// `void fetchList (in ACString aPayload, in nsIStreamListener aListener);`
#[inline]
pub unsafe fn FetchList(&self, aPayload: *const ::nsstring::nsACString, aListener: *const nsIStreamListener) -> ::nserror::nsresult {
((*self.vtable).FetchList)(self, aPayload, aListener)
}
/// ```text
/// /**
/// * Clear all data in the service.
/// * This API is for testing only.
/// */
/// ```
///
/// `void clear ();`
#[inline]
pub unsafe fn Clear(&self, ) -> ::nserror::nsresult {
((*self.vtable).Clear)(self, )
}
}