#[repr(C)]pub struct VNCoreMLModel { /* private fields */ }
VNCoreMLRequest
only.Expand description
The VNCoreMLModel uses an CoreML based model and prepares it for use with VNCoreMLRequests.
See also Apple’s documentation
Implementations§
Source§impl VNCoreMLModel
impl VNCoreMLModel
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn modelForMLModel_error(
model: &MLModel,
) -> Result<Retained<Self>, Retained<NSError>>
Available on crate feature objc2-core-ml
only.
pub unsafe fn modelForMLModel_error( model: &MLModel, ) -> Result<Retained<Self>, Retained<NSError>>
objc2-core-ml
only.Create a model container to be used with VNCoreMLRequest based on a Core ML model. This can fail if the model is not supported. Examples for a model that is not supported is a model that does not take an image as any of its inputs.
Parameter model
: The MLModel from CoreML to be used.
Parameter error
: Returns the error code and description, if the model is not supported.
Sourcepub unsafe fn inputImageFeatureName(&self) -> Retained<NSString>
pub unsafe fn inputImageFeatureName(&self) -> Retained<NSString>
The name of the MLFeatureValue that Vision will set from the VNRequestHandler. Vision will use the first input it finds by default but it can be set to another featureName instead.
Sourcepub unsafe fn setInputImageFeatureName(
&self,
input_image_feature_name: &NSString,
)
pub unsafe fn setInputImageFeatureName( &self, input_image_feature_name: &NSString, )
Setter for inputImageFeatureName
.
Sourcepub unsafe fn featureProvider(
&self,
) -> Option<Retained<ProtocolObject<dyn MLFeatureProvider>>>
Available on crate feature objc2-core-ml
only.
pub unsafe fn featureProvider( &self, ) -> Option<Retained<ProtocolObject<dyn MLFeatureProvider>>>
objc2-core-ml
only.An optional object conforming to the MLFeatureProvider protocol that is used by the model during the predict call to support inputs that are not supplied by Vision. Vision will provide the image for the inputImageFeatureName from the the VNRequestHandler. A feature provider is necessary for models that have more than one input and require those parameters to be set. Models that only have one image input will not use the feature provider as that input will be set by Vision.
Sourcepub unsafe fn setFeatureProvider(
&self,
feature_provider: Option<&ProtocolObject<dyn MLFeatureProvider>>,
)
Available on crate feature objc2-core-ml
only.
pub unsafe fn setFeatureProvider( &self, feature_provider: Option<&ProtocolObject<dyn MLFeatureProvider>>, )
objc2-core-ml
only.Setter for featureProvider
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
§Panics
May panic if the object is invalid (which may be the case for objects
returned from unavailable init
/new
methods).
§Example
Check that an instance of NSObject
has the precise class NSObject
.
use objc2::ClassType;
use objc2::runtime::NSObject;
let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.Use Ivar::load
instead.
§Safety
The object must have an instance variable with the given name, and it
must be of type T
.
See Ivar::load_ptr
for details surrounding this.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Attempt to downcast the object to a class of type T
.
This is the reference-variant. Use Retained::downcast
if you want
to convert a retained object to another type.
§Mutable classes
Some classes have immutable and mutable variants, such as NSString
and NSMutableString
.
When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.
So using this method to convert a NSString
to a NSMutableString
,
while not unsound, is generally frowned upon unless you created the
string yourself, or the API explicitly documents the string to be
mutable.
See Apple’s documentation on mutability and on
isKindOfClass:
for more details.
§Generic classes
Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.
You can, however, safely downcast to generic collections where all the
type-parameters are AnyObject
.
§Panics
This works internally by calling isKindOfClass:
. That means that the
object must have the instance method of that name, and an exception
will be thrown (if CoreFoundation is linked) or the process will abort
if that is not the case. In the vast majority of cases, you don’t need
to worry about this, since both root objects NSObject
and
NSProxy
implement this method.
§Examples
Cast an NSString
back and forth from NSObject
.
use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};
let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();
Try (and fail) to cast an NSObject
to an NSString
.
use objc2_foundation::{NSObject, NSString};
let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());
Try to cast to an array of strings.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();
This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.
Downcast when processing each element instead.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
for elem in arr {
if let Some(data) = elem.downcast_ref::<NSString>() {
// handle `data`
}
}
Trait Implementations§
Source§impl AsRef<AnyObject> for VNCoreMLModel
impl AsRef<AnyObject> for VNCoreMLModel
Source§impl AsRef<NSObject> for VNCoreMLModel
impl AsRef<NSObject> for VNCoreMLModel
Source§impl AsRef<VNCoreMLModel> for VNCoreMLModel
impl AsRef<VNCoreMLModel> for VNCoreMLModel
Source§impl Borrow<AnyObject> for VNCoreMLModel
impl Borrow<AnyObject> for VNCoreMLModel
Source§impl Borrow<NSObject> for VNCoreMLModel
impl Borrow<NSObject> for VNCoreMLModel
Source§impl ClassType for VNCoreMLModel
impl ClassType for VNCoreMLModel
Source§const NAME: &'static str = "VNCoreMLModel"
const NAME: &'static str = "VNCoreMLModel"
Source§type ThreadKind = <<VNCoreMLModel as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<VNCoreMLModel as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for VNCoreMLModel
impl Debug for VNCoreMLModel
Source§impl Deref for VNCoreMLModel
impl Deref for VNCoreMLModel
Source§impl Hash for VNCoreMLModel
impl Hash for VNCoreMLModel
Source§impl Message for VNCoreMLModel
impl Message for VNCoreMLModel
Source§impl NSObjectProtocol for VNCoreMLModel
impl NSObjectProtocol for VNCoreMLModel
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref