Struct NSFileManager

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

Available on crate feature NSFileManager only.

Apple’s documentation

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: &DynBlock<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>>, )

Setter for delegate.

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<&DynBlock<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<AnyObject>>

Available on crate feature NSObject only.

pub unsafe fn getFileProviderServicesForItemAtURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<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.

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 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 ClassType for NSFileManager

const NAME: &'static str = "NSFileManager"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSFileManager 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 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 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 Message for NSFileManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSFileManager

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 NSFileManager

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 NSFileManager

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

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

impl DowncastTarget for NSFileManager

impl Eq for NSFileManager