Generated file
Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/netwerk/protocol/http/nsIHttpAuthEntry.idl
//
/// `interface nsIHttpAuthIdentity : nsISupports`
///
/// ```text
/// /**
/// * nsIHttpAuthIdentity
/// * Defines an interface (domain, user, and password)
/// * identifying the HTTP authentication cache entry.
/// *
/// */
/// ```
///
// 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 nsIHttpAuthIdentity {
vtable: &'static nsIHttpAuthIdentityVTable,
/// 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 nsIHttpAuthIdentity.
unsafe impl XpCom for nsIHttpAuthIdentity {
const IID: nsIID = nsID(0x5a88870b, 0x92bd, 0x4c2f,
[0x81, 0x7a, 0x04, 0x13, 0x2c, 0xae, 0xf7, 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 nsIHttpAuthIdentity {
#[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 nsIHttpAuthIdentity.
// 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 nsIHttpAuthIdentityCoerce {
/// Cheaply cast a value of this type from a `nsIHttpAuthIdentity`.
fn coerce_from(v: &nsIHttpAuthIdentity) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIHttpAuthIdentityCoerce for nsIHttpAuthIdentity {
#[inline]
fn coerce_from(v: &nsIHttpAuthIdentity) -> &Self {
v
}
}
impl nsIHttpAuthIdentity {
/// Cast this `nsIHttpAuthIdentity` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIHttpAuthIdentityCoerce>(&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 nsIHttpAuthIdentity {
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> nsIHttpAuthIdentityCoerce for T {
#[inline]
fn coerce_from(v: &nsIHttpAuthIdentity) -> &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 nsIHttpAuthIdentity
// 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 nsIHttpAuthIdentityVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* readonly attribute AString domain; */
pub GetDomain: unsafe extern "system" fn (this: *const nsIHttpAuthIdentity, aDomain: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString user; */
pub GetUser: unsafe extern "system" fn (this: *const nsIHttpAuthIdentity, aUser: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString password; */
pub GetPassword: unsafe extern "system" fn (this: *const nsIHttpAuthIdentity, aPassword: *mut ::nsstring::nsAString) -> ::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 nsIHttpAuthIdentity {
/// `readonly attribute AString domain;`
#[inline]
pub unsafe fn GetDomain(&self, aDomain: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetDomain)(self, aDomain)
}
/// `readonly attribute AString user;`
#[inline]
pub unsafe fn GetUser(&self, aUser: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetUser)(self, aUser)
}
/// `readonly attribute AString password;`
#[inline]
pub unsafe fn GetPassword(&self, aPassword: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetPassword)(self, aPassword)
}
}
/// `interface nsIHttpAuthEntry : nsISupports`
///
/// ```text
/// /**
/// * nsIHttpAuthEntry
/// * Defines an interface representing a cache entry in the HTTP authentication 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 nsIHttpAuthEntry {
vtable: &'static nsIHttpAuthEntryVTable,
/// 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 nsIHttpAuthEntry.
unsafe impl XpCom for nsIHttpAuthEntry {
const IID: nsIID = nsID(0x9bdf473d, 0x63c2, 0x4cf8,
[0x92, 0xf8, 0x27, 0x0e, 0x80, 0xb8, 0xae, 0xba]);
}
// 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 nsIHttpAuthEntry {
#[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 nsIHttpAuthEntry.
// 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 nsIHttpAuthEntryCoerce {
/// Cheaply cast a value of this type from a `nsIHttpAuthEntry`.
fn coerce_from(v: &nsIHttpAuthEntry) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIHttpAuthEntryCoerce for nsIHttpAuthEntry {
#[inline]
fn coerce_from(v: &nsIHttpAuthEntry) -> &Self {
v
}
}
impl nsIHttpAuthEntry {
/// Cast this `nsIHttpAuthEntry` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIHttpAuthEntryCoerce>(&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 nsIHttpAuthEntry {
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> nsIHttpAuthEntryCoerce for T {
#[inline]
fn coerce_from(v: &nsIHttpAuthEntry) -> &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 nsIHttpAuthEntry
// 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 nsIHttpAuthEntryVTable {
/// 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 realm; */
pub GetRealm: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aRealm: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* readonly attribute ACString creds; */
pub GetCreds: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aCreds: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* readonly attribute ACString challenge; */
pub GetChallenge: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aChallenge: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* readonly attribute AString domain; */
pub GetDomain: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aDomain: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString user; */
pub GetUser: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aUser: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString password; */
pub GetPassword: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aPassword: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute nsIHttpAuthIdentity identity; */
pub GetIdentity: unsafe extern "system" fn (this: *const nsIHttpAuthEntry, aIdentity: *mut *const nsIHttpAuthIdentity) -> ::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 nsIHttpAuthEntry {
/// `readonly attribute ACString realm;`
#[inline]
pub unsafe fn GetRealm(&self, aRealm: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetRealm)(self, aRealm)
}
/// `readonly attribute ACString creds;`
#[inline]
pub unsafe fn GetCreds(&self, aCreds: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetCreds)(self, aCreds)
}
/// `readonly attribute ACString challenge;`
#[inline]
pub unsafe fn GetChallenge(&self, aChallenge: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetChallenge)(self, aChallenge)
}
/// `readonly attribute AString domain;`
#[inline]
pub unsafe fn GetDomain(&self, aDomain: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetDomain)(self, aDomain)
}
/// `readonly attribute AString user;`
#[inline]
pub unsafe fn GetUser(&self, aUser: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetUser)(self, aUser)
}
/// `readonly attribute AString password;`
#[inline]
pub unsafe fn GetPassword(&self, aPassword: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetPassword)(self, aPassword)
}
/// `readonly attribute nsIHttpAuthIdentity identity;`
#[inline]
pub unsafe fn GetIdentity(&self, aIdentity: *mut *const nsIHttpAuthIdentity) -> ::nserror::nsresult {
((*self.vtable).GetIdentity)(self, aIdentity)
}
}