Struct objc2_foundation::NSProgress

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

Available on crate feature NSProgress only.

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: &Block<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)

pub unsafe fn completedUnitCount(&self) -> i64

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

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.

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.

pub unsafe fn isCancellable(&self) -> bool

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

pub unsafe fn isPausable(&self) -> bool

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

pub unsafe fn isCancelled(&self) -> bool

pub unsafe fn isPaused(&self) -> bool

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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.

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.

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.

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.

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.

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.

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.

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSProgress

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for NSProgress

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<NSProgress> for NSProgress

fn as_mut(&mut self) -> &mut Self

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

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 BorrowMut<AnyObject> for NSProgress

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSProgress

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for NSProgress

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSProgress"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

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 DerefMut for NSProgress

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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 NSObjectProtocol for NSProgress

fn isEqual(&self, other: &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,

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: &NSProgress) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 Eq for NSProgress

impl Message for NSProgress

impl Send for NSProgress

impl StructuralPartialEq for NSProgress

impl Sync for NSProgress