Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/netwerk/socket/nsINamedPipeService.idl
//
/// `interface nsINamedPipeDataObserver : nsISupports`
///
/// ```text
/// /**
/// * nsINamedPipeDataObserver
/// *
/// * This is the callback interface for nsINamedPipeService.
/// * The functions are called by the internal thread in the nsINamedPipeService.
/// */
/// ```
///
// 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 nsINamedPipeDataObserver {
vtable: &'static nsINamedPipeDataObserverVTable,
/// 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 nsINamedPipeDataObserver.
unsafe impl XpCom for nsINamedPipeDataObserver {
const IID: nsIID = nsID(0xde4f460b, 0x94fd, 0x442c,
[0x90, 0x02, 0x16, 0x37, 0xbe, 0xb2, 0x18, 0x5a]);
}
// 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 nsINamedPipeDataObserver {
#[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 nsINamedPipeDataObserver.
// 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 nsINamedPipeDataObserverCoerce {
/// Cheaply cast a value of this type from a `nsINamedPipeDataObserver`.
fn coerce_from(v: &nsINamedPipeDataObserver) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsINamedPipeDataObserverCoerce for nsINamedPipeDataObserver {
#[inline]
fn coerce_from(v: &nsINamedPipeDataObserver) -> &Self {
v
}
}
impl nsINamedPipeDataObserver {
/// Cast this `nsINamedPipeDataObserver` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsINamedPipeDataObserverCoerce>(&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 nsINamedPipeDataObserver {
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> nsINamedPipeDataObserverCoerce for T {
#[inline]
fn coerce_from(v: &nsINamedPipeDataObserver) -> &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 nsINamedPipeDataObserver
// 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 nsINamedPipeDataObserverVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void onDataAvailable (in unsigned long aBytesTransferred, in voidPtr aOverlapped); */
pub OnDataAvailable: unsafe extern "system" fn (this: *const nsINamedPipeDataObserver, aBytesTransferred: u32, aOverlapped: *mut libc::c_void) -> ::nserror::nsresult,
/* void onError (in unsigned long aError, in voidPtr aOverlapped); */
pub OnError: unsafe extern "system" fn (this: *const nsINamedPipeDataObserver, aError: u32, aOverlapped: *mut libc::c_void) -> ::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 nsINamedPipeDataObserver {
/// ```text
/// /**
/// * onDataAvailable
/// *
/// * @param aBytesTransferred
/// * Transfered bytes during last transmission.
/// * @param aOverlapped
/// * Corresponding overlapped structure used by the async I/O
/// */
/// ```
///
/// `void onDataAvailable (in unsigned long aBytesTransferred, in voidPtr aOverlapped);`
#[inline]
pub unsafe fn OnDataAvailable(&self, aBytesTransferred: u32, aOverlapped: *mut libc::c_void) -> ::nserror::nsresult {
((*self.vtable).OnDataAvailable)(self, aBytesTransferred, aOverlapped)
}
/// ```text
/// /**
/// * onError
/// *
/// * @param aError
/// * Error code of the error.
/// * @param aOverlapped
/// * Corresponding overlapped structure used by the async I/O
/// */
/// ```
///
/// `void onError (in unsigned long aError, in voidPtr aOverlapped);`
#[inline]
pub unsafe fn OnError(&self, aError: u32, aOverlapped: *mut libc::c_void) -> ::nserror::nsresult {
((*self.vtable).OnError)(self, aError, aOverlapped)
}
}
/// `interface nsINamedPipeService : nsISupports`
///
/// ```text
/// /**
/// * nsINamedPipeService
/// */
/// ```
///
// 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 nsINamedPipeService {
vtable: &'static nsINamedPipeServiceVTable,
/// 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 nsINamedPipeService.
unsafe impl XpCom for nsINamedPipeService {
const IID: nsIID = nsID(0x1bf19133, 0x5625, 0x4ac8,
[0x83, 0x6a, 0x80, 0xb1, 0xc2, 0x15, 0xf7, 0x2b]);
}
// 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 nsINamedPipeService {
#[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 nsINamedPipeService.
// 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 nsINamedPipeServiceCoerce {
/// Cheaply cast a value of this type from a `nsINamedPipeService`.
fn coerce_from(v: &nsINamedPipeService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsINamedPipeServiceCoerce for nsINamedPipeService {
#[inline]
fn coerce_from(v: &nsINamedPipeService) -> &Self {
v
}
}
impl nsINamedPipeService {
/// Cast this `nsINamedPipeService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsINamedPipeServiceCoerce>(&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 nsINamedPipeService {
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> nsINamedPipeServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsINamedPipeService) -> &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 nsINamedPipeService
// 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 nsINamedPipeServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void addDataObserver (in voidPtr aHandle, in nsINamedPipeDataObserver aObserver); */
pub AddDataObserver: unsafe extern "system" fn (this: *const nsINamedPipeService, aHandle: *mut libc::c_void, aObserver: *const nsINamedPipeDataObserver) -> ::nserror::nsresult,
/* void removeDataObserver (in voidPtr aHandle, in nsINamedPipeDataObserver aObserver); */
pub RemoveDataObserver: unsafe extern "system" fn (this: *const nsINamedPipeService, aHandle: *mut libc::c_void, aObserver: *const nsINamedPipeDataObserver) -> ::nserror::nsresult,
/* boolean isOnCurrentThread (); */
pub IsOnCurrentThread: unsafe extern "system" fn (this: *const nsINamedPipeService, _retval: *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 nsINamedPipeService {
/// ```text
/// /**
/// * addDataObserver
/// *
/// * @param aHandle
/// * The handle that is going to be monitored for read/write operations.
/// * Only handles that are opened with overlapped IO are supported.
/// * @param aObserver
/// * The observer of the handle, the service strong-refs of the observer.
/// */
/// ```
///
/// `void addDataObserver (in voidPtr aHandle, in nsINamedPipeDataObserver aObserver);`
#[inline]
pub unsafe fn AddDataObserver(&self, aHandle: *mut libc::c_void, aObserver: *const nsINamedPipeDataObserver) -> ::nserror::nsresult {
((*self.vtable).AddDataObserver)(self, aHandle, aObserver)
}
/// ```text
/// /**
/// * removeDataObserver
/// *
/// * @param aHandle
/// The handle associated to the observer, and will be closed by the
/// service.
/// * @param aObserver
/// * The observer to be removed.
/// */
/// ```
///
/// `void removeDataObserver (in voidPtr aHandle, in nsINamedPipeDataObserver aObserver);`
#[inline]
pub unsafe fn RemoveDataObserver(&self, aHandle: *mut libc::c_void, aObserver: *const nsINamedPipeDataObserver) -> ::nserror::nsresult {
((*self.vtable).RemoveDataObserver)(self, aHandle, aObserver)
}
/// ```text
/// /**
/// * isOnCurrentThread
/// *
/// * @return the caller runs within the internal thread.
/// */
/// ```
///
/// `boolean isOnCurrentThread ();`
#[inline]
pub unsafe fn IsOnCurrentThread(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).IsOnCurrentThread)(self, _retval)
}
}