Struct MLFeatureValue

#[repr(C)]
pub struct MLFeatureValue { /* private fields */ }

Available on crate feature MLFeatureValue only.

An immutable variant holding a data value of a supported MLFeatureType

MLFeatureValue does not support type conversion in its accessor properties. It can also have a missing or undefined value of a well defined type.

See also Apple’s documentation

Implementations

impl MLFeatureValue

pub unsafe fn type(&self) -> MLFeatureType

Available on crate feature MLFeatureType only.

Type of the value for which the corresponding property below is held

pub unsafe fn isUndefined(&self) -> bool

True if the value represents a missing or undefined value

pub unsafe fn int64Value(&self) -> i64

Populated value if the type is MLFeatureTypeInt64

pub unsafe fn doubleValue(&self) -> c_double

Populated value if the type is MLFeatureTypeDouble

pub unsafe fn stringValue(&self) -> Retained<NSString>

Populated value if the type is MLFeatureTypeString

pub unsafe fn multiArrayValue(&self) -> Option<Retained<MLMultiArray>>

Available on crate feature MLMultiArray only.

Populated value if the type is MLFeatureTypeMultiArray

pub unsafe fn dictionaryValue( &self, ) -> Retained<NSDictionary<AnyObject, NSNumber>>

Populated value if the type is MLFeatureTypeDictionary

pub unsafe fn imageBufferValue(&self) -> Option<Retained<CVPixelBuffer>>

Available on crate feature objc2-core-video only.

Populated value if the type is MLFeatureTypeImage

pub unsafe fn sequenceValue(&self) -> Option<Retained<MLSequence>>

Available on crate feature MLSequence only.

Populated value if the type is MLFeatureTypeSequence

pub unsafe fn featureValueWithInt64(value: i64) -> Retained<Self>

Hold an object with the specified value

pub unsafe fn featureValueWithDouble(value: c_double) -> Retained<Self>

pub unsafe fn featureValueWithString(value: &NSString) -> Retained<Self>

pub unsafe fn featureValueWithMultiArray(value: &MLMultiArray) -> Retained<Self>

Available on crate feature MLMultiArray only.

pub unsafe fn featureValueWithPixelBuffer( value: &CVPixelBuffer, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

pub unsafe fn featureValueWithSequence(sequence: &MLSequence) -> Retained<Self>

Available on crate feature MLSequence only.

pub unsafe fn undefinedFeatureValueWithType( type: MLFeatureType, ) -> Retained<Self>

Available on crate feature MLFeatureType only.

Represent an undefined value of a specified type

pub unsafe fn featureValueWithDictionary_error( value: &NSDictionary<AnyObject, NSNumber>, ) -> Result<Retained<Self>, Retained<NSError>>

For encoding a sparse feature set or for encoding probabilities. Input keys that are not NSNumber * or NSString * are rejected on construction and return a MLModelErrorFeatureTypeMismatch error. Further validation for consistency occurs on evaluation

pub unsafe fn isEqualToFeatureValue(&self, value: &MLFeatureValue) -> bool

Returns a Boolean value that indicates whether a feature value is equal to another.

If the types of the MLFeatureValue objects “self” and “value” are integer in one case and double in the other (in either order) then those mixed mode numeric values are compared as NSNumbers. Otherwise if the types of the MLFeatureValue objects are different NO is returned. When “self” and “value” are both PixelBuffer MLFeatureValue types, only their CVPixelBufferRef values are compared for equality, the underlying arrays of pixelValues are not examined. [So, distinct PixelBuffer MLFeatureValue objects with distinct CVPixelBufferRef values which encapsulate the same array of pixels will compare not equal.] For all other (matching) MLFeatureValue types, the BOOL value returned is the result of comparing “self” with “value” via isEqualToNumber:, isEqualToString:, isEqualtoDictionary:, isEqualToMultiArray:, isEqualToArray: as chosen by the MLFeatureValue types.

impl MLFeatureValue

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

impl MLFeatureValue

MLImageConversion.

pub unsafe fn featureValueWithImageAtURL_pixelsWide_pixelsHigh_pixelFormatType_options_error( url: &NSURL, pixels_wide: NSInteger, pixels_high: NSInteger, pixel_format_type: u32, options: Option<&NSDictionary<MLFeatureValueImageOption, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature MLFeatureValue_MLImageConversion only.

Construct image feature value from an image on disk. Orientation is read from Exif if avaiable

pub unsafe fn featureValueWithImageAtURL_constraint_options_error( url: &NSURL, constraint: &MLImageConstraint, options: Option<&NSDictionary<MLFeatureValueImageOption, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features MLFeatureValue_MLImageConversion and MLImageConstraint only.

Construct image feature value from an image on disk, using a model specified image constraint. Orientation is read from Exif if avaiable

pub unsafe fn featureValueWithCGImage_pixelsWide_pixelsHigh_pixelFormatType_options_error( cg_image: &CGImage, pixels_wide: NSInteger, pixels_high: NSInteger, pixel_format_type: u32, options: Option<&NSDictionary<MLFeatureValueImageOption, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features MLFeatureValue_MLImageConversion and objc2-core-graphics only.

Construct image feature value from CGImage (orientation is assumed to be kCGImagePropertyOrientationUp)

pub unsafe fn featureValueWithCGImage_constraint_options_error( cg_image: &CGImage, constraint: &MLImageConstraint, options: Option<&NSDictionary<MLFeatureValueImageOption, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features MLFeatureValue_MLImageConversion and MLImageConstraint and objc2-core-graphics only.

Construct image feature value from CGImage, using the size and type information required by feature description (orientation is assumed to be kCGImagePropertyOrientationUp)

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use 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.

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

impl AsRef<AnyObject> for MLFeatureValue

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MLFeatureValue> for MLFeatureValue

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for MLFeatureValue

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for MLFeatureValue

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLFeatureValue

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLFeatureValue

const NAME: &'static str = "MLFeatureValue"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<MLFeatureValue as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for MLFeatureValue

type Result = MLFeatureValue

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MLFeatureValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for MLFeatureValue

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for MLFeatureValue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for MLFeatureValue

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MLFeatureValue

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for MLFeatureValue

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for MLFeatureValue

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for MLFeatureValue

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for MLFeatureValue

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for MLFeatureValue

impl Eq for MLFeatureValue

impl NSCoding for MLFeatureValue