Struct objc2_foundation::NSFileHandle

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

Available on crate feature NSFileHandle only.

Implementations

impl NSFileHandle

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

Available on crate feature NSData only.

pub unsafe fn initWithFileDescriptor_closeOnDealloc( this: Allocated<Self>, fd: c_int, closeopt: bool ) -> Retained<Self>

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder ) -> Option<Retained<Self>>

Available on crate feature NSCoder only.

pub unsafe fn readDataToEndOfFileAndReturnError( &self ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn readDataUpToLength_error( &self, length: NSUInteger ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn writeData_error( &self, data: &NSData ) -> Result<(), Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn getOffset_error( &self, offset_in_file: NonNull<c_ulonglong> ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn seekToEndReturningOffset_error( &self, offset_in_file: *mut c_ulonglong ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn seekToOffset_error( &self, offset: c_ulonglong ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn truncateAtOffset_error( &self, offset: c_ulonglong ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn synchronizeAndReturnError(&self) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn closeAndReturnError(&self) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

impl NSFileHandle

Methods declared on superclass NSObject

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

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

impl NSFileHandle

NSFileHandleCreation

pub unsafe fn fileHandleWithStandardInput() -> Retained<NSFileHandle>

pub unsafe fn fileHandleWithStandardOutput() -> Retained<NSFileHandle>

pub unsafe fn fileHandleWithStandardError() -> Retained<NSFileHandle>

pub unsafe fn fileHandleWithNullDevice() -> Retained<NSFileHandle>

pub unsafe fn fileHandleForReadingAtPath( path: &NSString ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn fileHandleForWritingAtPath( path: &NSString ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn fileHandleForUpdatingAtPath( path: &NSString ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn fileHandleForReadingFromURL_error( url: &NSURL ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn fileHandleForWritingToURL_error( url: &NSURL ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn fileHandleForUpdatingURL_error( url: &NSURL ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

impl NSFileHandle

NSFileHandleAsynchronousAccess

pub unsafe fn readInBackgroundAndNotifyForModes( &self, modes: Option<&NSArray<NSRunLoopMode>> )

Available on crate features NSArray and NSObjCRuntime and NSString only.

pub unsafe fn readInBackgroundAndNotify(&self)

pub unsafe fn readToEndOfFileInBackgroundAndNotifyForModes( &self, modes: Option<&NSArray<NSRunLoopMode>> )

Available on crate features NSArray and NSObjCRuntime and NSString only.

pub unsafe fn readToEndOfFileInBackgroundAndNotify(&self)

pub unsafe fn acceptConnectionInBackgroundAndNotifyForModes( &self, modes: Option<&NSArray<NSRunLoopMode>> )

Available on crate features NSArray and NSObjCRuntime and NSString only.

pub unsafe fn acceptConnectionInBackgroundAndNotify(&self)

pub unsafe fn waitForDataInBackgroundAndNotifyForModes( &self, modes: Option<&NSArray<NSRunLoopMode>> )

Available on crate features NSArray and NSObjCRuntime and NSString only.

pub unsafe fn waitForDataInBackgroundAndNotify(&self)

pub unsafe fn readabilityHandler( &self ) -> *mut Block<dyn Fn(NonNull<NSFileHandle>)>

Available on crate feature block2 only.

pub unsafe fn setReadabilityHandler( &self, readability_handler: Option<&Block<dyn Fn(NonNull<NSFileHandle>)>> )

Available on crate feature block2 only.

pub unsafe fn writeabilityHandler( &self ) -> *mut Block<dyn Fn(NonNull<NSFileHandle>)>

Available on crate feature block2 only.

pub unsafe fn setWriteabilityHandler( &self, writeability_handler: Option<&Block<dyn Fn(NonNull<NSFileHandle>)>> )

Available on crate feature block2 only.

impl NSFileHandle

NSFileHandlePlatformSpecific

pub unsafe fn initWithFileDescriptor( this: Allocated<Self>, fd: c_int ) -> Retained<Self>

pub unsafe fn fileDescriptor(&self) -> c_int

impl NSFileHandle

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

👎Deprecated

Available on crate feature NSData only.

pub unsafe fn readDataOfLength(&self, length: NSUInteger) -> Retained<NSData>

👎Deprecated

Available on crate feature NSData only.

pub unsafe fn writeData(&self, data: &NSData)

👎Deprecated

Available on crate feature NSData only.

pub unsafe fn offsetInFile(&self) -> c_ulonglong

👎Deprecated

pub unsafe fn seekToEndOfFile(&self) -> c_ulonglong

👎Deprecated

pub unsafe fn seekToFileOffset(&self, offset: c_ulonglong)

👎Deprecated

pub unsafe fn truncateFileAtOffset(&self, offset: c_ulonglong)

👎Deprecated

pub unsafe fn synchronizeFile(&self)

👎Deprecated

pub unsafe fn closeFile(&self)

👎Deprecated

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 NSFileHandle

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

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

impl AsMut<NSFileHandle> for NSFileHandle

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

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

impl AsMut<NSObject> for NSFileHandle

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

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

impl AsRef<AnyObject> for NSFileHandle

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSFileHandle> for NSFileHandle

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSFileHandle

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSFileHandle

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSFileHandle

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSFileHandle

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSFileHandle

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

Mutably borrows from an owned value.

impl ClassType for NSFileHandle

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSFileHandle"

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 NSFileHandle

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

Formats the value using the given formatter.

impl Deref for NSFileHandle

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSFileHandle

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

Mutably dereferences the value.

impl Hash for NSFileHandle

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 NSCoding for NSFileHandle

Available on crate feature NSObject only.

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for NSFileHandle

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 NSSecureCoding for NSFileHandle

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSFileHandle

fn eq(&self, other: &NSFileHandle) -> 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 NSFileHandle

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

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

impl Eq for NSFileHandle

impl Message for NSFileHandle

impl Send for NSFileHandle

impl StructuralPartialEq for NSFileHandle

impl Sync for NSFileHandle