Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/security/manager/ssl/nsIClientAuthDialogService.idl
//
/// `interface nsIClientAuthDialogCallback : 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 nsIClientAuthDialogCallback {
vtable: &'static nsIClientAuthDialogCallbackVTable,
/// 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 nsIClientAuthDialogCallback.
unsafe impl XpCom for nsIClientAuthDialogCallback {
const IID: nsIID = nsID(0x6b00d96d, 0xfb8a, 0x4c9f,
[0x96, 0x32, 0xc9, 0xe1, 0x23, 0x5b, 0xef, 0xce]);
}
// 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 nsIClientAuthDialogCallback {
#[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 nsIClientAuthDialogCallback.
// 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 nsIClientAuthDialogCallbackCoerce {
/// Cheaply cast a value of this type from a `nsIClientAuthDialogCallback`.
fn coerce_from(v: &nsIClientAuthDialogCallback) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIClientAuthDialogCallbackCoerce for nsIClientAuthDialogCallback {
#[inline]
fn coerce_from(v: &nsIClientAuthDialogCallback) -> &Self {
v
}
}
impl nsIClientAuthDialogCallback {
/// Cast this `nsIClientAuthDialogCallback` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIClientAuthDialogCallbackCoerce>(&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 nsIClientAuthDialogCallback {
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> nsIClientAuthDialogCallbackCoerce for T {
#[inline]
fn coerce_from(v: &nsIClientAuthDialogCallback) -> &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 nsIClientAuthDialogCallback
// 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 nsIClientAuthDialogCallbackVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void certificateChosen (in nsIX509Cert cert, in boolean rememberDecision); */
pub CertificateChosen: unsafe extern "system" fn (this: *const nsIClientAuthDialogCallback, cert: *const nsIX509Cert, rememberDecision: 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 nsIClientAuthDialogCallback {
/// `void certificateChosen (in nsIX509Cert cert, in boolean rememberDecision);`
#[inline]
pub unsafe fn CertificateChosen(&self, cert: *const nsIX509Cert, rememberDecision: bool) -> ::nserror::nsresult {
((*self.vtable).CertificateChosen)(self, cert, rememberDecision)
}
}
/// `interface nsIClientAuthDialogService : nsISupports`
///
/// ```text
/// /**
/// * Provides UI when a server requests a TLS client authentication certificate.
/// */
/// ```
///
// 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 nsIClientAuthDialogService {
vtable: &'static nsIClientAuthDialogServiceVTable,
/// 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 nsIClientAuthDialogService.
unsafe impl XpCom for nsIClientAuthDialogService {
const IID: nsIID = nsID(0xfa4c7520, 0x1433, 0x11d5,
[0xba, 0x24, 0x00, 0x10, 0x83, 0x03, 0xb1, 0x17]);
}
// 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 nsIClientAuthDialogService {
#[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 nsIClientAuthDialogService.
// 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 nsIClientAuthDialogServiceCoerce {
/// Cheaply cast a value of this type from a `nsIClientAuthDialogService`.
fn coerce_from(v: &nsIClientAuthDialogService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIClientAuthDialogServiceCoerce for nsIClientAuthDialogService {
#[inline]
fn coerce_from(v: &nsIClientAuthDialogService) -> &Self {
v
}
}
impl nsIClientAuthDialogService {
/// Cast this `nsIClientAuthDialogService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIClientAuthDialogServiceCoerce>(&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 nsIClientAuthDialogService {
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> nsIClientAuthDialogServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsIClientAuthDialogService) -> &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 nsIClientAuthDialogService
// 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 nsIClientAuthDialogServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* [must_use] void chooseCertificate (in AUTF8String hostname, in Array<nsIX509Cert> certArray, in nsILoadContext loadContext, in nsIClientAuthDialogCallback callback); */
pub ChooseCertificate: unsafe extern "system" fn (this: *const nsIClientAuthDialogService, hostname: *const ::nsstring::nsACString, certArray: *const thin_vec::ThinVec<Option<RefPtr<nsIX509Cert>>>, loadContext: *const nsILoadContext, callback: *const nsIClientAuthDialogCallback) -> ::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 nsIClientAuthDialogService {
/// ```text
/// /**
/// * Called when a user is asked to choose a certificate for client auth.
/// *
/// * @param hostname Hostname of the server.
/// * @param certArray Array of certificates the user can choose from.
/// * @param loadContext The nsILoadContext of the connection requesting a
/// * certificate. May be null, in which case the
/// * implementation will use the most recent window to show
/// * UI.
/// * @param callback The nsIClientAuthDialogCallback to call when a certificate
/// * has been chosen (or no certificate).
/// */
/// ```
///
/// `[must_use] void chooseCertificate (in AUTF8String hostname, in Array<nsIX509Cert> certArray, in nsILoadContext loadContext, in nsIClientAuthDialogCallback callback);`
#[inline]
pub unsafe fn ChooseCertificate(&self, hostname: *const ::nsstring::nsACString, certArray: *const thin_vec::ThinVec<Option<RefPtr<nsIX509Cert>>>, loadContext: *const nsILoadContext, callback: *const nsIClientAuthDialogCallback) -> ::nserror::nsresult {
((*self.vtable).ChooseCertificate)(self, hostname, certArray, loadContext, callback)
}
}