//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/security/manager/ssl/nsIPKCS11Token.idl
//
/// `interface nsIPKCS11Token : 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 nsIPKCS11Token {
vtable: &'static nsIPKCS11TokenVTable,
/// 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 nsIPKCS11Token.
unsafe impl XpCom for nsIPKCS11Token {
const IID: nsIID = nsID(0x51191434, 0x1dd2, 0x11b2,
[0xa1, 0x7c, 0xe4, 0x9c, 0x4e, 0x99, 0xa4, 0xe3]);
}
// 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 nsIPKCS11Token {
#[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 nsIPKCS11Token.
// 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 nsIPKCS11TokenCoerce {
/// Cheaply cast a value of this type from a `nsIPKCS11Token`.
fn coerce_from(v: &nsIPKCS11Token) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIPKCS11TokenCoerce for nsIPKCS11Token {
#[inline]
fn coerce_from(v: &nsIPKCS11Token) -> &Self {
v
}
}
impl nsIPKCS11Token {
/// Cast this `nsIPKCS11Token` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIPKCS11TokenCoerce>(&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 nsIPKCS11Token {
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> nsIPKCS11TokenCoerce for T {
#[inline]
fn coerce_from(v: &nsIPKCS11Token) -> &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 nsIPKCS11Token
// 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 nsIPKCS11TokenVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* [must_use] readonly attribute AUTF8String tokenName; */
pub GetTokenName: unsafe extern "system" fn (this: *const nsIPKCS11Token, aTokenName: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute boolean isInternalKeyToken; */
pub GetIsInternalKeyToken: unsafe extern "system" fn (this: *const nsIPKCS11Token, aIsInternalKeyToken: *mut bool) -> ::nserror::nsresult,
/* [must_use] readonly attribute AUTF8String tokenManID; */
pub GetTokenManID: unsafe extern "system" fn (this: *const nsIPKCS11Token, aTokenManID: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute AUTF8String tokenHWVersion; */
pub GetTokenHWVersion: unsafe extern "system" fn (this: *const nsIPKCS11Token, aTokenHWVersion: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute AUTF8String tokenFWVersion; */
pub GetTokenFWVersion: unsafe extern "system" fn (this: *const nsIPKCS11Token, aTokenFWVersion: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute AUTF8String tokenSerialNumber; */
pub GetTokenSerialNumber: unsafe extern "system" fn (this: *const nsIPKCS11Token, aTokenSerialNumber: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* [must_use] readonly attribute boolean isLoggedIn; */
pub GetIsLoggedIn: unsafe extern "system" fn (this: *const nsIPKCS11Token, aIsLoggedIn: *mut bool) -> ::nserror::nsresult,
/* [implicit_jscontext,must_use] Promise login (); */
/// Unable to generate binding because `jscontext is unsupported`
pub Login: *const ::libc::c_void,
/* [implicit_jscontext,must_use] Promise logout (); */
/// Unable to generate binding because `jscontext is unsupported`
pub Logout: *const ::libc::c_void,
/* [implicit_jscontext,must_use] Promise reset (); */
/// Unable to generate binding because `jscontext is unsupported`
pub Reset: *const ::libc::c_void,
/* [implicit_jscontext,must_use] Promise changePassword (in AUTF8String oldPassword, in AUTF8String newPassword); */
/// Unable to generate binding because `jscontext is unsupported`
pub ChangePassword: *const ::libc::c_void,
/* [must_use] readonly attribute boolean canHavePassword; */
pub GetCanHavePassword: unsafe extern "system" fn (this: *const nsIPKCS11Token, aCanHavePassword: *mut bool) -> ::nserror::nsresult,
/* [must_use] readonly attribute boolean hasPassword; */
pub GetHasPassword: unsafe extern "system" fn (this: *const nsIPKCS11Token, aHasPassword: *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 nsIPKCS11Token {
/// ```text
/// /**
/// * The name of the token
/// */
/// ```
///
/// `[must_use] readonly attribute AUTF8String tokenName;`
#[inline]
pub unsafe fn GetTokenName(&self, aTokenName: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetTokenName)(self, aTokenName)
}
/// `[must_use] readonly attribute boolean isInternalKeyToken;`
#[inline]
pub unsafe fn GetIsInternalKeyToken(&self, aIsInternalKeyToken: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetIsInternalKeyToken)(self, aIsInternalKeyToken)
}
/// ```text
/// /**
/// * Manufacturer ID of the token.
/// */
/// ```
///
/// `[must_use] readonly attribute AUTF8String tokenManID;`
#[inline]
pub unsafe fn GetTokenManID(&self, aTokenManID: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetTokenManID)(self, aTokenManID)
}
/// ```text
/// /**
/// * Hardware version of the token.
/// */
/// ```
///
/// `[must_use] readonly attribute AUTF8String tokenHWVersion;`
#[inline]
pub unsafe fn GetTokenHWVersion(&self, aTokenHWVersion: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetTokenHWVersion)(self, aTokenHWVersion)
}
/// ```text
/// /**
/// * Firmware version of the token.
/// */
/// ```
///
/// `[must_use] readonly attribute AUTF8String tokenFWVersion;`
#[inline]
pub unsafe fn GetTokenFWVersion(&self, aTokenFWVersion: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetTokenFWVersion)(self, aTokenFWVersion)
}
/// `[must_use] readonly attribute AUTF8String tokenSerialNumber;`
#[inline]
pub unsafe fn GetTokenSerialNumber(&self, aTokenSerialNumber: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).GetTokenSerialNumber)(self, aTokenSerialNumber)
}
/// ```text
/// /**
/// * Whether or not the token has been logged in to.
/// */
/// ```
///
/// `[must_use] readonly attribute boolean isLoggedIn;`
#[inline]
pub unsafe fn GetIsLoggedIn(&self, aIsLoggedIn: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetIsLoggedIn)(self, aIsLoggedIn)
}
/// ```text
/// /**
/// * Returns a promise that resolves when the login() operation has completed.
/// */
/// ```
///
/// `[implicit_jscontext,must_use] Promise login ();`
const _Login: () = ();
/// ```text
/// /**
/// * Returns a promise that resolves when the logout() operation has completed.
/// */
/// ```
///
/// `[implicit_jscontext,must_use] Promise logout ();`
const _Logout: () = ();
/// ```text
/// /**
/// * Returns a promise that resolves when the token has been reset. If there
/// * was a pin (password), it will have been removed. All secrets stored on the
/// * token will have been deleted or rendered inaccessible.
/// */
/// ```
///
/// `[implicit_jscontext,must_use] Promise reset ();`
const _Reset: () = ();
/// ```text
/// /**
/// * Returns a promise that resolves when the user pin (password) has been
/// * changed on the token. If no password has been set and `oldPassword` is
/// * empty, initializes the password to `newPassword`. Otherwise, if
/// * `oldPassword` is the current password, changes it to `newPassword`.
/// * Tokens with protected authentication paths are not supported.
/// */
/// ```
///
/// `[implicit_jscontext,must_use] Promise changePassword (in AUTF8String oldPassword, in AUTF8String newPassword);`
const _ChangePassword: () = ();
/// ```text
/// /**
/// * True if a password can be set on this token, and false otherwise.
/// */
/// ```
///
/// `[must_use] readonly attribute boolean canHavePassword;`
#[inline]
pub unsafe fn GetCanHavePassword(&self, aCanHavePassword: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetCanHavePassword)(self, aCanHavePassword)
}
/// ```text
/// /**
/// * True if a password has been configured for this token, and false otherwise.
/// * (Whether or not the user is currently logged in makes no difference.)
/// * In particular, this can be used to determine if a user has set a primary
/// * password (if this is the internal key token).
/// */
/// ```
///
/// `[must_use] readonly attribute boolean hasPassword;`
#[inline]
pub unsafe fn GetHasPassword(&self, aHasPassword: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetHasPassword)(self, aHasPassword)
}
}