Struct ICScannerFunctionalUnit

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

Available on crate feature ICScannerFunctionalUnits only.

ICScannerFunctionalUnit is an abstract class that represents a scanner functiona unit. ImageCaptureCore defines three concrete subclasses of ICScannerFunctionalUnit: ICScannerFunctionalUnitFlatbed, ICScannerFunctionalUnitPositiveTransparency, ICScannerFunctionalUnitNegativeTransparency and ICScannerFunctionalUnitDocumentFeeder. ICScannerDevice creates instances of these concrete subclasses.

See also Apple’s documentation

Implementations

impl ICScannerFunctionalUnit

pub unsafe fn type(&self) -> ICScannerFunctionalUnitType

Functional unit type.

pub unsafe fn pixelDataType(&self) -> ICScannerPixelDataType

The pixel data type.

pub unsafe fn setPixelDataType(&self, pixel_data_type: ICScannerPixelDataType)

Setter for pixelDataType.

pub unsafe fn supportedBitDepths(&self) -> Retained<NSIndexSet>

Supported bit depths. The values in this set are valid values defined by ICScannerBitDepth.

pub unsafe fn bitDepth(&self) -> ICScannerBitDepth

The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

pub unsafe fn setBitDepth(&self, bit_depth: ICScannerBitDepth)

Setter for bitDepth.

pub unsafe fn supportedMeasurementUnits(&self) -> Retained<NSIndexSet>

Supported measurement units. The values in this set are valid values defined by ICScannerMeasurementUnit.

pub unsafe fn measurementUnit(&self) -> ICScannerMeasurementUnit

Current measurement unit. This will always be one of the supported measurement units.

pub unsafe fn setMeasurementUnit( &self, measurement_unit: ICScannerMeasurementUnit, )

Setter for measurementUnit.

pub unsafe fn supportedResolutions(&self) -> Retained<NSIndexSet>

Supported scan resolutions in DPI.

pub unsafe fn preferredResolutions(&self) -> Retained<NSIndexSet>

Preferred scan resolutions in DPI.

pub unsafe fn resolution(&self) -> NSUInteger

Current scan resolution. This will always be one of the supported resolution values.

pub unsafe fn setResolution(&self, resolution: NSUInteger)

Setter for resolution.

pub unsafe fn nativeXResolution(&self) -> NSUInteger

Optical resolution along the X axis.

pub unsafe fn nativeYResolution(&self) -> NSUInteger

Optical resolution along the Y axis.

pub unsafe fn supportedScaleFactors(&self) -> Retained<NSIndexSet>

Supported scale factors in percentage.

pub unsafe fn preferredScaleFactors(&self) -> Retained<NSIndexSet>

Preferred scale factors in percentage.

pub unsafe fn scaleFactor(&self) -> NSUInteger

Current scale factor. This will always be one of the supported scale factor values.

pub unsafe fn setScaleFactor(&self, scale_factor: NSUInteger)

Setter for scaleFactor.

pub unsafe fn templates(&self) -> Retained<NSArray<ICScannerFeatureTemplate>>

An array of objects of type ICScannerFeatureTemplate.

pub unsafe fn vendorFeatures( &self, ) -> Option<Retained<NSArray<ICScannerFeature>>>

An array of objects of type ICScannerFeature.

pub unsafe fn physicalSize(&self) -> NSSize

Physical size of the scan area in current measurement unit.

pub unsafe fn scanArea(&self) -> NSRect

This property along with scanAreaOrientation describes the area to be scanned.

pub unsafe fn setScanArea(&self, scan_area: NSRect)

Setter for scanArea.

pub unsafe fn scanAreaOrientation(&self) -> ICEXIFOrientationType

Available on crate feature ImageCaptureConstants only.

Desired orientation of the scan area. This property along with scanArea describes the area to be scanned.

This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

pub unsafe fn setScanAreaOrientation( &self, scan_area_orientation: ICEXIFOrientationType, )

Available on crate feature ImageCaptureConstants only.

Setter for scanAreaOrientation.

pub unsafe fn acceptsThresholdForBlackAndWhiteScanning(&self) -> bool

Indicates if this functional unit accepts threshold value to be used when performing a scan in black & white.

pub unsafe fn usesThresholdForBlackAndWhiteScanning(&self) -> bool

Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

pub unsafe fn setUsesThresholdForBlackAndWhiteScanning( &self, uses_threshold_for_black_and_white_scanning: bool, )

Setter for usesThresholdForBlackAndWhiteScanning.

pub unsafe fn defaultThresholdForBlackAndWhiteScanning(&self) -> c_uchar

Default threshold value used when performing a scan in black & white. This value is from 0 to 255.

pub unsafe fn thresholdForBlackAndWhiteScanning(&self) -> c_uchar

Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

pub unsafe fn setThresholdForBlackAndWhiteScanning( &self, threshold_for_black_and_white_scanning: c_uchar, )

Setter for thresholdForBlackAndWhiteScanning.

pub unsafe fn state(&self) -> ICScannerFunctionalUnitState

Indicates the current state of the functional unit.

pub unsafe fn scanInProgress(&self) -> bool

Indicates if a scan is in progress.

pub unsafe fn scanProgressPercentDone(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Indicates percentage of scan completed.

pub unsafe fn canPerformOverviewScan(&self) -> bool

Indicates if this functional unit can perfrom an overview scan. Not all functional units can perform an overview scan. For example, a document feeder or a sheet feeder unit cannot perform an overview scan.

pub unsafe fn overviewScanInProgress(&self) -> bool

Indicates if an overview scan is in progress.

pub unsafe fn overviewImage(&self) -> Option<Retained<CGImage>>

Available on crate feature objc2-core-graphics only.

Overview scan image. This property will be NULL for functional units that do not support overview scans.

pub unsafe fn overviewResolution(&self) -> NSUInteger

Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

pub unsafe fn setOverviewResolution(&self, overview_resolution: NSUInteger)

Setter for overviewResolution.

impl ICScannerFunctionalUnit

Methods declared on superclass NSObject.

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

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

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 ICScannerFunctionalUnit

fn as_ref(&self) -> &AnyObject

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

impl AsRef<ICScannerFunctionalUnit> for ICScannerFunctionalUnit

fn as_ref(&self) -> &Self

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

impl AsRef<ICScannerFunctionalUnit> for ICScannerFunctionalUnitDocumentFeeder

fn as_ref(&self) -> &ICScannerFunctionalUnit

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

impl AsRef<ICScannerFunctionalUnit> for ICScannerFunctionalUnitFlatbed

fn as_ref(&self) -> &ICScannerFunctionalUnit

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

impl AsRef<ICScannerFunctionalUnit> for ICScannerFunctionalUnitNegativeTransparency

fn as_ref(&self) -> &ICScannerFunctionalUnit

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

impl AsRef<ICScannerFunctionalUnit> for ICScannerFunctionalUnitPositiveTransparency

fn as_ref(&self) -> &ICScannerFunctionalUnit

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

impl AsRef<NSObject> for ICScannerFunctionalUnit

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for ICScannerFunctionalUnit

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<ICScannerFunctionalUnit> for ICScannerFunctionalUnitDocumentFeeder

fn borrow(&self) -> &ICScannerFunctionalUnit

Immutably borrows from an owned value.

impl Borrow<ICScannerFunctionalUnit> for ICScannerFunctionalUnitFlatbed

fn borrow(&self) -> &ICScannerFunctionalUnit

Immutably borrows from an owned value.

impl Borrow<ICScannerFunctionalUnit> for ICScannerFunctionalUnitNegativeTransparency

fn borrow(&self) -> &ICScannerFunctionalUnit

Immutably borrows from an owned value.

impl Borrow<ICScannerFunctionalUnit> for ICScannerFunctionalUnitPositiveTransparency

fn borrow(&self) -> &ICScannerFunctionalUnit

Immutably borrows from an owned value.

impl Borrow<NSObject> for ICScannerFunctionalUnit

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ICScannerFunctionalUnit

const NAME: &'static str = "ICScannerFunctionalUnit"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ICScannerFunctionalUnit 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 Debug for ICScannerFunctionalUnit

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

Formats the value using the given formatter.

impl Deref for ICScannerFunctionalUnit

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ICScannerFunctionalUnit

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 ICScannerFunctionalUnit

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ICScannerFunctionalUnit

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 PartialEq for ICScannerFunctionalUnit

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 ICScannerFunctionalUnit

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

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

impl DowncastTarget for ICScannerFunctionalUnit

impl Eq for ICScannerFunctionalUnit