//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/ml/nsIMLModelResolver.idl
//
/// `interface nsIMLModelDownloadAuthorizationCallback : nsISupports`
///
/// ```text
/// /**
/// * Result callback for nsIMLModelResolver.authorizeDownload. Runs with true to
/// * allow the download, false to deny it.
/// */
/// ```
///
// 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 nsIMLModelDownloadAuthorizationCallback {
vtable: &'static nsIMLModelDownloadAuthorizationCallbackVTable,
/// 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 nsIMLModelDownloadAuthorizationCallback.
unsafe impl XpCom for nsIMLModelDownloadAuthorizationCallback {
const IID: nsIID = nsID(0xd8e9208e, 0x4ffb, 0x4da4,
[0xb1, 0x9d, 0x89, 0x23, 0xea, 0x59, 0x93, 0x4a]);
}
// 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 nsIMLModelDownloadAuthorizationCallback {
#[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 nsIMLModelDownloadAuthorizationCallback.
// 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 nsIMLModelDownloadAuthorizationCallbackCoerce {
/// Cheaply cast a value of this type from a `nsIMLModelDownloadAuthorizationCallback`.
fn coerce_from(v: &nsIMLModelDownloadAuthorizationCallback) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIMLModelDownloadAuthorizationCallbackCoerce for nsIMLModelDownloadAuthorizationCallback {
#[inline]
fn coerce_from(v: &nsIMLModelDownloadAuthorizationCallback) -> &Self {
v
}
}
impl nsIMLModelDownloadAuthorizationCallback {
/// Cast this `nsIMLModelDownloadAuthorizationCallback` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIMLModelDownloadAuthorizationCallbackCoerce>(&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 nsIMLModelDownloadAuthorizationCallback {
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> nsIMLModelDownloadAuthorizationCallbackCoerce for T {
#[inline]
fn coerce_from(v: &nsIMLModelDownloadAuthorizationCallback) -> &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 nsIMLModelDownloadAuthorizationCallback
// 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 nsIMLModelDownloadAuthorizationCallbackVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void resolve (in boolean aAllow); */
pub Resolve: unsafe extern "system" fn (this: *const nsIMLModelDownloadAuthorizationCallback, aAllow: 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 nsIMLModelDownloadAuthorizationCallback {
/// `void resolve (in boolean aAllow);`
#[inline]
pub unsafe fn Resolve(&self, aAllow: bool) -> ::nserror::nsresult {
((*self.vtable).Resolve)(self, aAllow)
}
}
/// `interface nsIMLModelResolver : nsISupports`
///
/// ```text
/// /**
/// * Per-task policy component for HWInference model management: maps a task's
/// * abstract model ids to ModelHub artifacts, and decides whether downloading
/// * one is allowed. Parent-process only, looked up by HWInference as
/// * "@mozilla.org/ml/model-resolver;1?task=<task>". Because aId must match one
/// * of the resolver's known ids, a less trusted requesting process can only
/// * select among approved artifacts, never name one itself.
/// */
/// ```
///
// 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 nsIMLModelResolver {
vtable: &'static nsIMLModelResolverVTable,
/// 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 nsIMLModelResolver.
unsafe impl XpCom for nsIMLModelResolver {
const IID: nsIID = nsID(0xf3be56e2, 0xaa39, 0x4335,
[0x87, 0xc2, 0x9b, 0x35, 0x3d, 0xb5, 0xd3, 0xcd]);
}
// 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 nsIMLModelResolver {
#[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 nsIMLModelResolver.
// 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 nsIMLModelResolverCoerce {
/// Cheaply cast a value of this type from a `nsIMLModelResolver`.
fn coerce_from(v: &nsIMLModelResolver) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIMLModelResolverCoerce for nsIMLModelResolver {
#[inline]
fn coerce_from(v: &nsIMLModelResolver) -> &Self {
v
}
}
impl nsIMLModelResolver {
/// Cast this `nsIMLModelResolver` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIMLModelResolverCoerce>(&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 nsIMLModelResolver {
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> nsIMLModelResolverCoerce for T {
#[inline]
fn coerce_from(v: &nsIMLModelResolver) -> &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 nsIMLModelResolver
// 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 nsIMLModelResolverVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void resolve (in AUTF8String aId, out AUTF8String aEngine, out AUTF8String aModel, out AUTF8String aRevision, out AUTF8String aFilename); */
pub Resolve: unsafe extern "system" fn (this: *const nsIMLModelResolver, aId: *const ::nsstring::nsACString, aEngine: *mut ::nsstring::nsACString, aModel: *mut ::nsstring::nsACString, aRevision: *mut ::nsstring::nsACString, aFilename: *mut ::nsstring::nsACString) -> ::nserror::nsresult,
/* void authorizeDownload (in AUTF8String aModel, in AUTF8String aRevision, in AUTF8String aFilename, in WindowGlobalParent aWindow, in AString aProgressToken, in nsIMLModelDownloadAuthorizationCallback aCallback); */
pub AuthorizeDownload: unsafe extern "system" fn (this: *const nsIMLModelResolver, aModel: *const ::nsstring::nsACString, aRevision: *const ::nsstring::nsACString, aFilename: *const ::nsstring::nsACString, aWindow: *const libc::c_void, aProgressToken: *const ::nsstring::nsAString, aCallback: *const nsIMLModelDownloadAuthorizationCallback) -> ::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 nsIMLModelResolver {
/// ```text
/// /**
/// * Resolve aId to a concrete ModelHub artifact. Purely a table lookup
/// * against static, in-tree data; always synchronous. Throws
/// * NS_ERROR_NOT_AVAILABLE if aId is unknown.
/// */
/// ```
///
/// `void resolve (in AUTF8String aId, out AUTF8String aEngine, out AUTF8String aModel, out AUTF8String aRevision, out AUTF8String aFilename);`
#[inline]
pub unsafe fn Resolve(&self, aId: *const ::nsstring::nsACString, aEngine: *mut ::nsstring::nsACString, aModel: *mut ::nsstring::nsACString, aRevision: *mut ::nsstring::nsACString, aFilename: *mut ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).Resolve)(self, aId, aEngine, aModel, aRevision, aFilename)
}
/// ```text
/// /**
/// * Decide whether an artifact returned by resolve() may be downloaded for
/// * aWindow, the document responsible for the request. HWInference has
/// * already checked aWindow belongs to the requesting process. aWindow is
/// * null for privileged-chrome requests: no document to anchor UI on, and the
/// * origin is already trusted.
/// *
/// * aProgressToken tags this download's "ml-model-download-progress"
/// * notifications, so a consumer can tell concurrent downloads apart.
/// *
/// * Called on the parent main thread; answers via aCallback, possibly async,
/// * since an implementation may show UI first.
/// */
/// ```
///
/// `void authorizeDownload (in AUTF8String aModel, in AUTF8String aRevision, in AUTF8String aFilename, in WindowGlobalParent aWindow, in AString aProgressToken, in nsIMLModelDownloadAuthorizationCallback aCallback);`
#[inline]
pub unsafe fn AuthorizeDownload(&self, aModel: *const ::nsstring::nsACString, aRevision: *const ::nsstring::nsACString, aFilename: *const ::nsstring::nsACString, aWindow: *const libc::c_void, aProgressToken: *const ::nsstring::nsAString, aCallback: *const nsIMLModelDownloadAuthorizationCallback) -> ::nserror::nsresult {
((*self.vtable).AuthorizeDownload)(self, aModel, aRevision, aFilename, aWindow, aProgressToken, aCallback)
}
}