Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/netwerk/protocol/http/nsICORSPreflightCacheEntry.idl
//
/// `interface nsICORSPreflightCacheEntry : nsISupports`
///
/// ```text
/// /**
/// * nsICORSPreflightCacheEntry
/// * Defines an interface representing a cache entry in the preflight cache.
/// *
/// */
/// ```
///
// 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 nsICORSPreflightCacheEntry {
vtable: &'static nsICORSPreflightCacheEntryVTable,
/// 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 nsICORSPreflightCacheEntry.
unsafe impl XpCom for nsICORSPreflightCacheEntry {
const IID: nsIID = nsID(0xf43f2098, 0x53dc, 0x4554,
[0xb7, 0x06, 0x04, 0x0b, 0x4c, 0xe1, 0xe5, 0x87]);
}
// 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 nsICORSPreflightCacheEntry {
#[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 nsICORSPreflightCacheEntry.
// 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 nsICORSPreflightCacheEntryCoerce {
/// Cheaply cast a value of this type from a `nsICORSPreflightCacheEntry`.
fn coerce_from(v: &nsICORSPreflightCacheEntry) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsICORSPreflightCacheEntryCoerce for nsICORSPreflightCacheEntry {
#[inline]
fn coerce_from(v: &nsICORSPreflightCacheEntry) -> &Self {
v
}
}
impl nsICORSPreflightCacheEntry {
/// Cast this `nsICORSPreflightCacheEntry` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsICORSPreflightCacheEntryCoerce>(&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 nsICORSPreflightCacheEntry {
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> nsICORSPreflightCacheEntryCoerce for T {
#[inline]
fn coerce_from(v: &nsICORSPreflightCacheEntry) -> &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 nsICORSPreflightCacheEntry
// 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 nsICORSPreflightCacheEntryVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* readonly attribute ACString key; */
pub GetKey: unsafe extern "system" fn (this: *const nsICORSPreflightCacheEntry, aKey: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* readonly attribute nsIURI URI; */
pub GetURI: unsafe extern "system" fn (this: *const nsICORSPreflightCacheEntry, aURI: *mut*const nsIURI) -> ::nserror::nsresult,
/* [implicit_jscontext] readonly attribute jsval originAttributes; */
/// Unable to generate binding because `special type jsval unsupported`
pub GetOriginAttributes: *const ::libc::c_void,
/* [binaryname(OriginAttributesRef),noscript,nostdcall,notxpcom] const_OriginAttributes OriginAttributesRef (); */
/// Unable to generate binding because `nostdcall is unsupported`
pub OriginAttributesRef: *const ::libc::c_void,
/* readonly attribute nsIPrincipal principal; */
pub GetPrincipal: unsafe extern "system" fn (this: *const nsICORSPreflightCacheEntry, aPrincipal: *mut*const nsIPrincipal) -> ::nserror::nsresult,
/* readonly attribute boolean privateBrowsing; */
pub GetPrivateBrowsing: unsafe extern "system" fn (this: *const nsICORSPreflightCacheEntry, aPrivateBrowsing: *mut bool) -> ::nserror::nsresult,
/* readonly attribute boolean withCredentials; */
pub GetWithCredentials: unsafe extern "system" fn (this: *const nsICORSPreflightCacheEntry, aWithCredentials: *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 nsICORSPreflightCacheEntry {
/// ```text
/// /**
/// * The serialized key identifying this cache entry as a string
/// */
/// ```
///
/// `readonly attribute ACString key;`
#[inline]
pub unsafe fn GetKey(&self, aKey: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetKey)(self, aKey)
}
/// ```text
/// /**
/// * The URI used in the key
/// */
/// ```
///
/// `readonly attribute nsIURI URI;`
#[inline]
pub unsafe fn GetURI(&self, aURI: *mut*const nsIURI) -> ::nserror::nsresult {
((*self.vtable).GetURI)(self, aURI)
}
/// ```text
/// /**
/// * OriginAttributes used in the key
/// */
/// ```
///
/// `[implicit_jscontext] readonly attribute jsval originAttributes;`
const _GetOriginAttributes: () = ();
/// ```text
/// /**
/// * Same OriginAttributes as above, callable from c++
/// */
/// ```
///
/// `[binaryname(OriginAttributesRef),noscript,nostdcall,notxpcom] const_OriginAttributes OriginAttributesRef ();`
const _OriginAttributesRef: () = ();
/// ```text
/// /**
/// * Principal used to generate the key serialization
/// */
/// ```
///
/// `readonly attribute nsIPrincipal principal;`
#[inline]
pub unsafe fn GetPrincipal(&self, aPrincipal: *mut*const nsIPrincipal) -> ::nserror::nsresult {
((*self.vtable).GetPrincipal)(self, aPrincipal)
}
/// ```text
/// /**
/// * Whether this cache entry is associated with private browsing.
/// */
/// ```
///
/// `readonly attribute boolean privateBrowsing;`
#[inline]
pub unsafe fn GetPrivateBrowsing(&self, aPrivateBrowsing: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetPrivateBrowsing)(self, aPrivateBrowsing)
}
/// ```text
/// /**
/// * Whether the the cache entry includes those with credentials
/// */
/// ```
///
/// `readonly attribute boolean withCredentials;`
#[inline]
pub unsafe fn GetWithCredentials(&self, aWithCredentials: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetWithCredentials)(self, aWithCredentials)
}
}