Struct NSProgress

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

Available on crate feature NSProgress only.

Apple’s documentation

Implementations

impl NSProgress

pub unsafe fn currentProgress() -> Option<Retained<NSProgress>>

pub unsafe fn progressWithTotalUnitCount( unit_count: i64, ) -> Retained<NSProgress>

pub unsafe fn discreteProgressWithTotalUnitCount( unit_count: i64, ) -> Retained<NSProgress>

pub unsafe fn progressWithTotalUnitCount_parent_pendingUnitCount( unit_count: i64, parent: &NSProgress, portion_of_parent_total_unit_count: i64, ) -> Retained<NSProgress>

pub unsafe fn initWithParent_userInfo( this: Allocated<Self>, parent_progress_or_nil: Option<&NSProgress>, user_info_or_nil: Option<&NSDictionary<NSProgressUserInfoKey, AnyObject>>, ) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

pub unsafe fn becomeCurrentWithPendingUnitCount(&self, unit_count: i64)

pub unsafe fn performAsCurrentWithPendingUnitCount_usingBlock( &self, unit_count: i64, work: &DynBlock<dyn Fn() + '_>, )

Available on crate feature block2 only.

pub unsafe fn resignCurrent(&self)

pub unsafe fn addChild_withPendingUnitCount( &self, child: &NSProgress, in_unit_count: i64, )

pub unsafe fn totalUnitCount(&self) -> i64

pub unsafe fn setTotalUnitCount(&self, total_unit_count: i64)

Setter for totalUnitCount.

pub unsafe fn completedUnitCount(&self) -> i64

pub unsafe fn setCompletedUnitCount(&self, completed_unit_count: i64)

Setter for completedUnitCount.

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

Available on crate feature NSString only.

pub unsafe fn setLocalizedDescription( &self, localized_description: Option<&NSString>, )

Available on crate feature NSString only.

Setter for localizedDescription.

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

Available on crate feature NSString only.

pub unsafe fn setLocalizedAdditionalDescription( &self, localized_additional_description: Option<&NSString>, )

Available on crate feature NSString only.

Setter for localizedAdditionalDescription.

pub unsafe fn isCancellable(&self) -> bool

pub unsafe fn setCancellable(&self, cancellable: bool)

Setter for isCancellable.

pub unsafe fn isPausable(&self) -> bool

pub unsafe fn setPausable(&self, pausable: bool)

Setter for isPausable.

pub unsafe fn isCancelled(&self) -> bool

pub unsafe fn isPaused(&self) -> bool

pub unsafe fn cancellationHandler(&self) -> *mut DynBlock<dyn Fn()>

Available on crate feature block2 only.

pub unsafe fn setCancellationHandler( &self, cancellation_handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for cancellationHandler.

pub unsafe fn pausingHandler(&self) -> *mut DynBlock<dyn Fn()>

Available on crate feature block2 only.

pub unsafe fn setPausingHandler( &self, pausing_handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for pausingHandler.

pub unsafe fn resumingHandler(&self) -> *mut DynBlock<dyn Fn()>

Available on crate feature block2 only.

pub unsafe fn setResumingHandler( &self, resuming_handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for resumingHandler.

pub unsafe fn setUserInfoObject_forKey( &self, object_or_nil: Option<&AnyObject>, key: &NSProgressUserInfoKey, )

Available on crate feature NSString only.

pub unsafe fn isIndeterminate(&self) -> bool

pub unsafe fn fractionCompleted(&self) -> c_double

pub unsafe fn isFinished(&self) -> bool

pub unsafe fn cancel(&self)

pub unsafe fn pause(&self)

pub unsafe fn resume(&self)

pub unsafe fn userInfo( &self, ) -> Retained<NSDictionary<NSProgressUserInfoKey, AnyObject>>

Available on crate features NSDictionary and NSString only.

pub unsafe fn kind(&self) -> Option<Retained<NSProgressKind>>

Available on crate feature NSString only.

pub unsafe fn setKind(&self, kind: Option<&NSProgressKind>)

Available on crate feature NSString only.

Setter for kind.

pub unsafe fn estimatedTimeRemaining(&self) -> Option<Retained<NSNumber>>

Available on crate feature NSValue only.

pub unsafe fn setEstimatedTimeRemaining( &self, estimated_time_remaining: Option<&NSNumber>, )

Available on crate feature NSValue only.

Setter for estimatedTimeRemaining.

pub unsafe fn throughput(&self) -> Option<Retained<NSNumber>>

Available on crate feature NSValue only.

pub unsafe fn setThroughput(&self, throughput: Option<&NSNumber>)

Available on crate feature NSValue only.

Setter for throughput.

pub unsafe fn fileOperationKind( &self, ) -> Option<Retained<NSProgressFileOperationKind>>

Available on crate feature NSString only.

pub unsafe fn setFileOperationKind( &self, file_operation_kind: Option<&NSProgressFileOperationKind>, )

Available on crate feature NSString only.

Setter for fileOperationKind.

pub unsafe fn fileURL(&self) -> Option<Retained<NSURL>>

Available on crate feature NSURL only.

pub unsafe fn setFileURL(&self, file_url: Option<&NSURL>)

Available on crate feature NSURL only.

Setter for fileURL.

pub unsafe fn fileTotalCount(&self) -> Option<Retained<NSNumber>>

Available on crate feature NSValue only.

pub unsafe fn setFileTotalCount(&self, file_total_count: Option<&NSNumber>)

Available on crate feature NSValue only.

Setter for fileTotalCount.

pub unsafe fn fileCompletedCount(&self) -> Option<Retained<NSNumber>>

Available on crate feature NSValue only.

pub unsafe fn setFileCompletedCount( &self, file_completed_count: Option<&NSNumber>, )

Available on crate feature NSValue only.

Setter for fileCompletedCount.

pub unsafe fn publish(&self)

pub unsafe fn unpublish(&self)

pub unsafe fn addSubscriberForFileURL_withPublishingHandler( url: &NSURL, publishing_handler: NSProgressPublishingHandler, ) -> Retained<AnyObject>

Available on crate features NSURL and block2 only.

pub unsafe fn removeSubscriber(subscriber: &AnyObject)

pub unsafe fn isOld(&self) -> bool

impl NSProgress

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 NSProgress

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSProgress

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSProgress> for NSProgress

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSProgress

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSProgress

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSProgress

const NAME: &'static str = "NSProgress"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSProgress 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 NSProgress

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

Formats the value using the given formatter.

impl Deref for NSProgress

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSProgress

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 NSProgress

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSProgress

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 NSProgress

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 NSProgress

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

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

impl DowncastTarget for NSProgress

impl Eq for NSProgress

impl Send for NSProgress

impl Sync for NSProgress