//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/xre/nsIASWebAuthSessionRequest.idl
//
/// `interface nsIASWebAuthSessionRequest : nsISupports`
///
/// ```text
/// /**
/// * Represents a single web authentication request from macOS.
/// * The native handler passes this request to the JS service, which uses it
/// * to start the authentication flow and complete or cancel the request.
/// */
/// ```
///
// 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 nsIASWebAuthSessionRequest {
vtable: &'static nsIASWebAuthSessionRequestVTable,
/// 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 nsIASWebAuthSessionRequest.
unsafe impl XpCom for nsIASWebAuthSessionRequest {
const IID: nsIID = nsID(0xe54beddf, 0xa7b2, 0x4d37,
[0x93, 0x48, 0xa1, 0xe2, 0x95, 0x49, 0xe4, 0xdd]);
}
// 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 nsIASWebAuthSessionRequest {
#[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 nsIASWebAuthSessionRequest.
// 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 nsIASWebAuthSessionRequestCoerce {
/// Cheaply cast a value of this type from a `nsIASWebAuthSessionRequest`.
fn coerce_from(v: &nsIASWebAuthSessionRequest) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIASWebAuthSessionRequestCoerce for nsIASWebAuthSessionRequest {
#[inline]
fn coerce_from(v: &nsIASWebAuthSessionRequest) -> &Self {
v
}
}
impl nsIASWebAuthSessionRequest {
/// Cast this `nsIASWebAuthSessionRequest` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIASWebAuthSessionRequestCoerce>(&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 nsIASWebAuthSessionRequest {
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> nsIASWebAuthSessionRequestCoerce for T {
#[inline]
fn coerce_from(v: &nsIASWebAuthSessionRequest) -> &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 nsIASWebAuthSessionRequest
// 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 nsIASWebAuthSessionRequestVTable {
/// 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 uuid; */
pub GetUuid: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aUuid: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString url; */
pub GetUrl: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aUrl: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString callbackScheme; */
pub GetCallbackScheme: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aCallbackScheme: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute boolean hasCallback; */
pub GetHasCallback: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aHasCallback: *mut bool) -> ::nserror::nsresult,
/* readonly attribute boolean useEphemeralSession; */
pub GetUseEphemeralSession: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aUseEphemeralSession: *mut bool) -> ::nserror::nsresult,
/* readonly attribute Array<AString> additionalHeaderNames; */
pub GetAdditionalHeaderNames: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, aAdditionalHeaderNames: *mut thin_vec::ThinVec<::nsstring::nsString>) -> ::nserror::nsresult,
/* AString getAdditionalHeader (in AString name); */
pub GetAdditionalHeader: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, name: *const ::nsstring::nsAString, _retval: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* boolean matchesCallbackURL (in AString url); */
pub MatchesCallbackURL: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, url: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult,
/* void complete (in AString callbackURL); */
pub Complete: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest, callbackURL: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void cancel (); */
pub Cancel: unsafe extern "system" fn (this: *const nsIASWebAuthSessionRequest) -> ::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 nsIASWebAuthSessionRequest {
/// ```text
/// /** macOS-assigned identifier for the request. */
/// ```
///
/// `readonly attribute AString uuid;`
#[inline]
pub unsafe fn GetUuid(&self, aUuid: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetUuid)(self, aUuid)
}
/// ```text
/// /** The authorization URL to load. */
/// ```
///
/// `readonly attribute AString url;`
#[inline]
pub unsafe fn GetUrl(&self, aUrl: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetUrl)(self, aUrl)
}
/// ```text
/// /**
/// * The custom callback scheme the flow completes with, or the empty string
/// * when the request instead uses an opaque HTTPS callback.
/// */
/// ```
///
/// `readonly attribute AString callbackScheme;`
#[inline]
pub unsafe fn GetCallbackScheme(&self, aCallbackScheme: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetCallbackScheme)(self, aCallbackScheme)
}
/// ```text
/// /**
/// * True when the request uses an HTTPS callback. Use matchesCallbackURL()
/// * to check whether a URL matches the callback.
/// */
/// ```
///
/// `readonly attribute boolean hasCallback;`
#[inline]
pub unsafe fn GetHasCallback(&self, aHasCallback: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetHasCallback)(self, aHasCallback)
}
/// ```text
/// /** True when the session must use a private browsing session. */
/// ```
///
/// `readonly attribute boolean useEphemeralSession;`
#[inline]
pub unsafe fn GetUseEphemeralSession(&self, aUseEphemeralSession: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetUseEphemeralSession)(self, aUseEphemeralSession)
}
/// ```text
/// /** Names of the app-supplied headers to send with the initial request. */
/// ```
///
/// `readonly attribute Array<AString> additionalHeaderNames;`
#[inline]
pub unsafe fn GetAdditionalHeaderNames(&self, aAdditionalHeaderNames: *mut thin_vec::ThinVec<::nsstring::nsString>) -> ::nserror::nsresult {
((*self.vtable).GetAdditionalHeaderNames)(self, aAdditionalHeaderNames)
}
/// ```text
/// /** Value of an app-supplied header, or the empty string if not present. */
/// ```
///
/// `AString getAdditionalHeader (in AString name);`
#[inline]
pub unsafe fn GetAdditionalHeader(&self, name: *const ::nsstring::nsAString, _retval: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetAdditionalHeader)(self, name, _retval)
}
/// ```text
/// /**
/// * Tests a candidate navigation URL against the request's opaque HTTPS
/// * callback. Always false when hasCallback is false.
/// */
/// ```
///
/// `boolean matchesCallbackURL (in AString url);`
#[inline]
pub unsafe fn MatchesCallbackURL(&self, url: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).MatchesCallbackURL)(self, url, _retval)
}
/// ```text
/// /** Completes the request with the resolved callback URL. */
/// ```
///
/// `void complete (in AString callbackURL);`
#[inline]
pub unsafe fn Complete(&self, callbackURL: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).Complete)(self, callbackURL)
}
/// ```text
/// /** Cancels the request. */
/// ```
///
/// `void cancel ();`
#[inline]
pub unsafe fn Cancel(&self, ) -> ::nserror::nsresult {
((*self.vtable).Cancel)(self, )
}
}