mozilla-central/__GENERATED__/dist/xpcrs/rt/nsIWindowsMutex.rs

Copy as Markdown

Other Tools

//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/mozapps/defaultagent/nsIWindowsMutex.idl
//
/// `interface nsIWindowsMutex : nsISupports`
///
/// ```text
/// /**
/// * Interact with Windows named mutexes.
/// *
/// * Generally you don't want a Windows named mutex, you want one of the many Gecko
/// * locking primitives. But when you do want cross-application instance or even
/// * cross-installation coordination, a Windows named mutex might be an
/// * appropriate tool.
/// */
/// ```
///
// 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 nsIWindowsMutex {
vtable: &'static nsIWindowsMutexVTable,
/// 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
// 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 nsIWindowsMutex.
unsafe impl XpCom for nsIWindowsMutex {
const IID: nsIID = nsID(0x26f09999, 0xc26e, 0x4b72,
[0x87, 0x47, 0x5a, 0xda, 0xef, 0xa0, 0x91, 0x4c]);
}
// 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 nsIWindowsMutex {
#[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 nsIWindowsMutex.
// 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 nsIWindowsMutexCoerce {
/// Cheaply cast a value of this type from a `nsIWindowsMutex`.
fn coerce_from(v: &nsIWindowsMutex) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWindowsMutexCoerce for nsIWindowsMutex {
#[inline]
fn coerce_from(v: &nsIWindowsMutex) -> &Self {
v
}
}
impl nsIWindowsMutex {
/// Cast this `nsIWindowsMutex` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWindowsMutexCoerce>(&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 nsIWindowsMutex {
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> nsIWindowsMutexCoerce for T {
#[inline]
fn coerce_from(v: &nsIWindowsMutex) -> &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 nsIWindowsMutex
// 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 nsIWindowsMutexVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void tryLock (); */
pub TryLock: unsafe extern "system" fn (this: *const nsIWindowsMutex) -> ::nserror::nsresult,
/* boolean isLocked (); */
pub IsLocked: unsafe extern "system" fn (this: *const nsIWindowsMutex, _retval: *mut bool) -> ::nserror::nsresult,
/* void unlock (); */
pub Unlock: unsafe extern "system" fn (this: *const nsIWindowsMutex) -> ::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 nsIWindowsMutex {
/// ```text
/// /**
/// * Locks the mutex.
/// *
/// * Note that this will not block waiting to lock. It attempts to lock the mutex
/// * and if it can't immediately, NS_ERROR_NOT_AVAILABLE will be thrown.
/// *
/// * This function succeeds when an abandoned mutex is found, therefore is
/// * inappropriate for use if an abandoned mutex might imply the locked resource
/// * is in a corrupt state.
/// *
/// * @throws NS_ERROR_NOT_AVAILABLE
/// * If unable to lock the mutex.
/// */
/// ```
///
/// `void tryLock ();`
#[inline]
pub unsafe fn TryLock(&self, ) -> ::nserror::nsresult {
((*self.vtable).TryLock)(self, )
}
/// ```text
/// /**
/// * Returns whether the mutex is locked.
/// *
/// * @return {boolean} true if locked, false if unlocked.
/// */
/// ```
///
/// `boolean isLocked ();`
#[inline]
pub unsafe fn IsLocked(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).IsLocked)(self, _retval)
}
/// ```text
/// /**
/// * Unlocks the mutex.
/// * @throws NS_ERROR_UNEXPECTED
/// * If unable to release mutex.
/// */
/// ```
///
/// `void unlock ();`
#[inline]
pub unsafe fn Unlock(&self, ) -> ::nserror::nsresult {
((*self.vtable).Unlock)(self, )
}
}
/// `interface nsIWindowsMutexFactory : nsISupports`
///
// 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 nsIWindowsMutexFactory {
vtable: &'static nsIWindowsMutexFactoryVTable,
/// 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
// 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 nsIWindowsMutexFactory.
unsafe impl XpCom for nsIWindowsMutexFactory {
const IID: nsIID = nsID(0xd54fe2b7, 0x438f, 0x4629,
[0x97, 0x06, 0x1a, 0xcd, 0xa5, 0xb5, 0x10, 0x88]);
}
// 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 nsIWindowsMutexFactory {
#[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 nsIWindowsMutexFactory.
// 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 nsIWindowsMutexFactoryCoerce {
/// Cheaply cast a value of this type from a `nsIWindowsMutexFactory`.
fn coerce_from(v: &nsIWindowsMutexFactory) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWindowsMutexFactoryCoerce for nsIWindowsMutexFactory {
#[inline]
fn coerce_from(v: &nsIWindowsMutexFactory) -> &Self {
v
}
}
impl nsIWindowsMutexFactory {
/// Cast this `nsIWindowsMutexFactory` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWindowsMutexFactoryCoerce>(&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 nsIWindowsMutexFactory {
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> nsIWindowsMutexFactoryCoerce for T {
#[inline]
fn coerce_from(v: &nsIWindowsMutexFactory) -> &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 nsIWindowsMutexFactory
// 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 nsIWindowsMutexFactoryVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* nsIWindowsMutex createMutex (in AString aName); */
pub CreateMutex: unsafe extern "system" fn (this: *const nsIWindowsMutexFactory, aName: *const ::nsstring::nsAString, _retval: *mut *const nsIWindowsMutex) -> ::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 nsIWindowsMutexFactory {
/// ```text
/// /**
/// * Creates a Windows named mutex.
/// *
/// * @param {AString} aName
/// * The system-wide name of the mutex.
/// * @return {nsIWindowsMutex}
/// * The created Windows mutex.
/// * @throws NS_ERROR_NOT_AVAILABLE
/// * If unable to create mutex.
/// */
/// ```
///
/// `nsIWindowsMutex createMutex (in AString aName);`
#[inline]
pub unsafe fn CreateMutex(&self, aName: *const ::nsstring::nsAString, _retval: *mut *const nsIWindowsMutex) -> ::nserror::nsresult {
((*self.vtable).CreateMutex)(self, aName, _retval)
}
}