Struct objc2_foundation::NSFileManager

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

Available on crate feature NSFileManager only.

Implementations

impl NSFileManager

pub unsafe fn defaultManager() -> Retained<NSFileManager>

pub unsafe fn mountedVolumeURLsIncludingResourceValuesForKeys_options( &self, property_keys: Option<&NSArray<NSURLResourceKey>>, options: NSVolumeEnumerationOptions ) -> Option<Retained<NSArray<NSURL>>>

Available on crate features NSArray and NSString and NSURL only.

pub unsafe fn unmountVolumeAtURL_options_completionHandler( &self, url: &NSURL, mask: NSFileManagerUnmountOptions, completion_handler: &Block<dyn Fn(*mut NSError)> )

Available on crate features NSError and NSURL and block2 only.

pub unsafe fn contentsOfDirectoryAtURL_includingPropertiesForKeys_options_error( &self, url: &NSURL, keys: Option<&NSArray<NSURLResourceKey>>, mask: NSDirectoryEnumerationOptions ) -> Result<Retained<NSArray<NSURL>>, Retained<NSError>>

Available on crate features NSArray and NSError and NSString and NSURL only.

pub unsafe fn URLsForDirectory_inDomains( &self, directory: NSSearchPathDirectory, domain_mask: NSSearchPathDomainMask ) -> Retained<NSArray<NSURL>>

Available on crate features NSArray and NSPathUtilities and NSURL only.

pub unsafe fn URLForDirectory_inDomain_appropriateForURL_create_error( &self, directory: NSSearchPathDirectory, domain: NSSearchPathDomainMask, url: Option<&NSURL>, should_create: bool ) -> Result<Retained<NSURL>, Retained<NSError>>

Available on crate features NSError and NSPathUtilities and NSURL only.

pub unsafe fn getRelationship_ofDirectoryAtURL_toItemAtURL_error( &self, out_relationship: NonNull<NSURLRelationship>, directory_url: &NSURL, other_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn getRelationship_ofDirectory_inDomain_toItemAtURL_error( &self, out_relationship: NonNull<NSURLRelationship>, directory: NSSearchPathDirectory, domain_mask: NSSearchPathDomainMask, url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSPathUtilities and NSURL only.

pub unsafe fn createDirectoryAtURL_withIntermediateDirectories_attributes_error( &self, url: &NSURL, create_intermediates: bool, attributes: Option<&NSDictionary<NSFileAttributeKey, AnyObject>> ) -> Result<(), Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString and NSURL only.

pub unsafe fn createSymbolicLinkAtURL_withDestinationURL_error( &self, url: &NSURL, dest_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn delegate( &self ) -> Option<Retained<ProtocolObject<dyn NSFileManagerDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSFileManagerDelegate>> )

pub unsafe fn setAttributes_ofItemAtPath_error( &self, attributes: &NSDictionary<NSFileAttributeKey, AnyObject>, path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn createDirectoryAtPath_withIntermediateDirectories_attributes_error( &self, path: &NSString, create_intermediates: bool, attributes: Option<&NSDictionary<NSFileAttributeKey, AnyObject>> ) -> Result<(), Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn contentsOfDirectoryAtPath_error( &self, path: &NSString ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>

Available on crate features NSArray and NSError and NSString only.

pub unsafe fn subpathsOfDirectoryAtPath_error( &self, path: &NSString ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>

Available on crate features NSArray and NSError and NSString only.

pub unsafe fn attributesOfItemAtPath_error( &self, path: &NSString ) -> Result<Retained<NSDictionary<NSFileAttributeKey, AnyObject>>, Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn attributesOfFileSystemForPath_error( &self, path: &NSString ) -> Result<Retained<NSDictionary<NSFileAttributeKey, AnyObject>>, Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn createSymbolicLinkAtPath_withDestinationPath_error( &self, path: &NSString, dest_path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn destinationOfSymbolicLinkAtPath_error( &self, path: &NSString ) -> Result<Retained<NSString>, Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn copyItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn moveItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn linkItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn removeItemAtPath_error( &self, path: &NSString ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn copyItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn moveItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn linkItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

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

Available on crate features NSError and NSURL only.

pub unsafe fn trashItemAtURL_resultingItemURL_error( &self, url: &NSURL, out_resulting_url: Option<&mut Option<Retained<NSURL>>> ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn fileAttributesAtPath_traverseLink( &self, path: &NSString, yorn: bool ) -> Option<Retained<NSDictionary>>

👎Deprecated: Use -attributesOfItemAtPath:error: instead

Available on crate features NSDictionary and NSString only.

pub unsafe fn changeFileAttributes_atPath( &self, attributes: &NSDictionary, path: &NSString ) -> bool

👎Deprecated: Use -setAttributes:ofItemAtPath:error: instead

Available on crate features NSDictionary and NSString only.

pub unsafe fn directoryContentsAtPath( &self, path: &NSString ) -> Option<Retained<NSArray>>

👎Deprecated: Use -contentsOfDirectoryAtPath:error: instead

Available on crate features NSArray and NSString only.

pub unsafe fn fileSystemAttributesAtPath( &self, path: &NSString ) -> Option<Retained<NSDictionary>>

👎Deprecated: Use -attributesOfFileSystemForPath:error: instead

Available on crate features NSDictionary and NSString only.

pub unsafe fn pathContentOfSymbolicLinkAtPath( &self, path: &NSString ) -> Option<Retained<NSString>>

👎Deprecated: Use -destinationOfSymbolicLinkAtPath:error:

Available on crate feature NSString only.

pub unsafe fn createSymbolicLinkAtPath_pathContent( &self, path: &NSString, otherpath: &NSString ) -> bool

👎Deprecated: Use -createSymbolicLinkAtPath:error: instead

Available on crate feature NSString only.

pub unsafe fn createDirectoryAtPath_attributes( &self, path: &NSString, attributes: &NSDictionary ) -> bool

👎Deprecated: Use -createDirectoryAtPath:withIntermediateDirectories:attributes:error: instead

Available on crate features NSDictionary and NSString only.

pub unsafe fn linkPath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject> ) -> bool

👎Deprecated: Not supported

Available on crate feature NSString only.

pub unsafe fn copyPath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject> ) -> bool

👎Deprecated: Not supported

Available on crate feature NSString only.

pub unsafe fn movePath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject> ) -> bool

👎Deprecated: Not supported

Available on crate feature NSString only.

pub unsafe fn removeFileAtPath_handler( &self, path: &NSString, handler: Option<&AnyObject> ) -> bool

👎Deprecated: Not supported

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn changeCurrentDirectoryPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn fileExistsAtPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn fileExistsAtPath_isDirectory( &self, path: &NSString, is_directory: *mut Bool ) -> bool

Available on crate feature NSString only.

pub unsafe fn isReadableFileAtPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn isWritableFileAtPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn isExecutableFileAtPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn isDeletableFileAtPath(&self, path: &NSString) -> bool

Available on crate feature NSString only.

pub unsafe fn contentsEqualAtPath_andPath( &self, path1: &NSString, path2: &NSString ) -> bool

Available on crate feature NSString only.

pub unsafe fn displayNameAtPath(&self, path: &NSString) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn componentsToDisplayForPath( &self, path: &NSString ) -> Option<Retained<NSArray<NSString>>>

Available on crate features NSArray and NSString only.

pub unsafe fn enumeratorAtPath( &self, path: &NSString ) -> Option<Retained<NSDirectoryEnumerator<NSString>>>

Available on crate features NSEnumerator and NSString only.

pub unsafe fn enumeratorAtURL_includingPropertiesForKeys_options_errorHandler( &self, url: &NSURL, keys: Option<&NSArray<NSURLResourceKey>>, mask: NSDirectoryEnumerationOptions, handler: Option<&Block<dyn Fn(NonNull<NSURL>, NonNull<NSError>) -> Bool>> ) -> Option<Retained<NSDirectoryEnumerator<NSURL>>>

Available on crate features NSArray and NSEnumerator and NSError and NSString and NSURL and block2 only.

pub unsafe fn subpathsAtPath( &self, path: &NSString ) -> Option<Retained<NSArray<NSString>>>

Available on crate features NSArray and NSString only.

pub unsafe fn contentsAtPath(&self, path: &NSString) -> Option<Retained<NSData>>

Available on crate features NSData and NSString only.

pub unsafe fn createFileAtPath_contents_attributes( &self, path: &NSString, data: Option<&NSData>, attr: Option<&NSDictionary<NSFileAttributeKey, AnyObject>> ) -> bool

Available on crate features NSData and NSDictionary and NSString only.

pub unsafe fn fileSystemRepresentationWithPath( &self, path: &NSString ) -> NonNull<c_char>

Available on crate feature NSString only.

pub unsafe fn stringWithFileSystemRepresentation_length( &self, str: NonNull<c_char>, len: NSUInteger ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn replaceItemAtURL_withItemAtURL_backupItemName_options_resultingItemURL_error( &self, original_item_url: &NSURL, new_item_url: &NSURL, backup_item_name: Option<&NSString>, options: NSFileManagerItemReplacementOptions, resulting_url: Option<&mut Option<Retained<NSURL>>> ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString and NSURL only.

pub unsafe fn setUbiquitous_itemAtURL_destinationURL_error( &self, flag: bool, url: &NSURL, destination_url: &NSURL ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn isUbiquitousItemAtURL(&self, url: &NSURL) -> bool

Available on crate feature NSURL only.

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

Available on crate features NSError and NSURL only.

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

Available on crate features NSError and NSURL only.

pub unsafe fn URLForUbiquityContainerIdentifier( &self, container_identifier: Option<&NSString> ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

pub unsafe fn URLForPublishingUbiquitousItemAtURL_expirationDate_error( &self, url: &NSURL, out_date: Option<&mut Option<Retained<NSDate>>> ) -> Result<Retained<NSURL>, Retained<NSError>>

Available on crate features NSDate and NSError and NSURL only.

pub unsafe fn ubiquityIdentityToken(&self) -> Option<Retained<TodoProtocols>>

Available on crate feature NSObject only.

pub unsafe fn getFileProviderServicesForItemAtURL_completionHandler( &self, url: &NSURL, completion_handler: &Block<dyn Fn(*mut NSDictionary<NSFileProviderServiceName, NSFileProviderService>, *mut NSError)> )

Available on crate features NSDictionary and NSError and NSString and NSURL and block2 only.

pub unsafe fn containerURLForSecurityApplicationGroupIdentifier( &self, group_identifier: &NSString ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

impl NSFileManager

Methods declared on superclass NSObject

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

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

impl NSFileManager

NSUserInformation

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

pub unsafe fn homeDirectoryForUser( &self, user_name: &NSString ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

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 NSFileManager

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

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

impl AsMut<NSFileManager> for NSFileManager

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

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

impl AsMut<NSObject> for NSFileManager

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

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

impl AsRef<AnyObject> for NSFileManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSFileManager> for NSFileManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSFileManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSFileManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSFileManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSFileManager

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSFileManager

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

Mutably borrows from an owned value.

impl ClassType for NSFileManager

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSFileManager"

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 NSFileManager

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

Formats the value using the given formatter.

impl Deref for NSFileManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSFileManager

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

Mutably dereferences the value.

impl Hash for NSFileManager

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 NSFileManager

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 NSFileManager

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

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

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

impl Eq for NSFileManager

impl Message for NSFileManager

impl StructuralPartialEq for NSFileManager