Struct CIDataMatrixCodeDescriptor

Source

pub struct CIDataMatrixCodeDescriptor { /* private fields */ }

Available on crate feature CIBarcodeDescriptor only.

Expand description

A concrete subclass the Core Image Barcode Descriptor that represents an Data Matrix code symbol.

A Data Matrix code symbol is a 2D barcode format defined by the ISO/IEC 16022:2006(E) standard. It encodes data in square or rectangular symbol with solid lines on the left and bottom sides

Implementations§

Source §

impl CIDataMatrixCodeDescriptor

Source

pub unsafe fn errorCorrectedPayload(&self) -> Retained<NSData>

The error-corrected payload containing the data encoded in the Data Matrix code symbol.

DataMatrix symbols are specified bn ISO/IEC 16022:2006(E). ECC 200-type symbols will always have an even number of rows and columns.

For ECC 200-type symbols, the phases of encoding data into a symbol are described in section 5.1 – Encode procedure overview. The error corrected payload comprises the de-interleaved bits of the message described at the end of Step 1: Data encodation.

Source

pub unsafe fn rowCount(&self) -> NSInteger

The number of rows in the Data Matrix code symbol.

Refer to ISO/IEC 16022:2006(E) for valid module row and column count combinations.

Source

pub unsafe fn columnCount(&self) -> NSInteger

The number of columns in the Data Matrix code symbol.

Refer to ISO/IEC 16022:2006(E) for valid module row and column count combinations.

Source

pub unsafe fn eccVersion(&self) -> CIDataMatrixCodeECCVersion

The error correction version of the Data Matrix code symbol.

The possible error correction version are enumerated in CIDataMatrixCodeECCVersion. Any symbol with an even number of rows and columns will be ECC 200.

Source

pub unsafe fn initWithPayload_rowCount_columnCount_eccVersion( this: Allocated<Self>, error_corrected_payload: &NSData, row_count: NSInteger, column_count: NSInteger, ecc_version: CIDataMatrixCodeECCVersion, ) -> Option<Retained<Self>>

Initializes a Data Matrix code descriptor for the given payload and parameters.

Parameters:
errorCorrectedPayload: The data to encode in the Data Matrix code symbol.
rowCount: The number of rows in the Data Matrix code symbol.
columnCount: The number of columns in the Data Matrix code symbol.
eccVersion: The CIDataMatrixCodeECCVersion for the Data Matrix code symbol.
Returns: An initialized CIAztecCodeDescriptor instance or nil if the parameters are invalid

Source

pub unsafe fn descriptorWithPayload_rowCount_columnCount_eccVersion( error_corrected_payload: &NSData, row_count: NSInteger, column_count: NSInteger, ecc_version: CIDataMatrixCodeECCVersion, ) -> Option<Retained<Self>>

Creates a Data Matrix code descriptor for the given payload and parameters.

Parameters:
errorCorrectedPayload: The data to encode in the Data Matrix code symbol.
rowCount: The number of rows in the Data Matrix code symbol.
columnCount: The number of columns in the Data Matrix code symbol.
eccVersion: The CIDataMatrixCodeECCVersion for the Data Matrix code symbol.
Returns: An autoreleased CIAztecCodeDescriptor instance or nil if the parameters are invalid

Source §

impl CIDataMatrixCodeDescriptor

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

Source

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.

Source

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`
    }
}