pub struct NSFileManager { /* private fields */ }NSFileManager only.Expand description
Implementations§
Source§impl NSFileManager
impl NSFileManager
pub fn defaultManager() -> Retained<NSFileManager>
pub fn mountedVolumeURLsIncludingResourceValuesForKeys_options( &self, property_keys: Option<&NSArray<NSURLResourceKey>>, options: NSVolumeEnumerationOptions, ) -> Option<Retained<NSArray<NSURL>>>
NSArray and NSString and NSURL only.Sourcepub 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 unmountVolumeAtURL_options_completionHandler( &self, url: &NSURL, mask: NSFileManagerUnmountOptions, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )
NSError and NSURL and block2 only.§Safety
completion_handler block must be sendable.
pub fn contentsOfDirectoryAtURL_includingPropertiesForKeys_options_error( &self, url: &NSURL, keys: Option<&NSArray<NSURLResourceKey>>, mask: NSDirectoryEnumerationOptions, ) -> Result<Retained<NSArray<NSURL>>, Retained<NSError>>
NSArray and NSError and NSString and NSURL only.pub fn URLsForDirectory_inDomains( &self, directory: NSSearchPathDirectory, domain_mask: NSSearchPathDomainMask, ) -> Retained<NSArray<NSURL>>
NSArray and NSPathUtilities and NSURL only.pub fn URLForDirectory_inDomain_appropriateForURL_create_error( &self, directory: NSSearchPathDirectory, domain: NSSearchPathDomainMask, url: Option<&NSURL>, should_create: bool, ) -> Result<Retained<NSURL>, Retained<NSError>>
NSError and NSPathUtilities and NSURL only.Sourcepub 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_ofDirectoryAtURL_toItemAtURL_error( &self, out_relationship: NonNull<NSURLRelationship>, directory_url: &NSURL, other_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.§Safety
out_relationship must be a valid pointer.
Sourcepub 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 getRelationship_ofDirectory_inDomain_toItemAtURL_error( &self, out_relationship: NonNull<NSURLRelationship>, directory: NSSearchPathDirectory, domain_mask: NSSearchPathDomainMask, url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSPathUtilities and NSURL only.§Safety
out_relationship must be a valid pointer.
Sourcepub 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 createDirectoryAtURL_withIntermediateDirectories_attributes_error( &self, url: &NSURL, create_intermediates: bool, attributes: Option<&NSDictionary<NSFileAttributeKey, AnyObject>>, ) -> Result<(), Retained<NSError>>
NSDictionary and NSError and NSString and NSURL only.§Safety
attributes generic should be of the correct type.
pub fn createSymbolicLinkAtURL_withDestinationURL_error( &self, url: &NSURL, dest_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.Sourcepub unsafe fn delegate(
&self,
) -> Option<Retained<ProtocolObject<dyn NSFileManagerDelegate>>>
pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSFileManagerDelegate>>>
§Safety
This is not retained internally, you must ensure the object is still alive.
Sourcepub unsafe fn setDelegate(
&self,
delegate: Option<&ProtocolObject<dyn NSFileManagerDelegate>>,
)
pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSFileManagerDelegate>>, )
Sourcepub 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 setAttributes_ofItemAtPath_error( &self, attributes: &NSDictionary<NSFileAttributeKey, AnyObject>, path: &NSString, ) -> Result<(), Retained<NSError>>
NSDictionary and NSError and NSString only.§Safety
attributes generic should be of the correct type.
Sourcepub 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 createDirectoryAtPath_withIntermediateDirectories_attributes_error( &self, path: &NSString, create_intermediates: bool, attributes: Option<&NSDictionary<NSFileAttributeKey, AnyObject>>, ) -> Result<(), Retained<NSError>>
NSDictionary and NSError and NSString only.§Safety
attributes generic should be of the correct type.
pub fn contentsOfDirectoryAtPath_error( &self, path: &NSString, ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>
NSArray and NSError and NSString only.pub fn subpathsOfDirectoryAtPath_error( &self, path: &NSString, ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>
NSArray and NSError and NSString only.pub fn attributesOfItemAtPath_error( &self, path: &NSString, ) -> Result<Retained<NSDictionary<NSFileAttributeKey, AnyObject>>, Retained<NSError>>
NSDictionary and NSError and NSString only.pub fn attributesOfFileSystemForPath_error( &self, path: &NSString, ) -> Result<Retained<NSDictionary<NSFileAttributeKey, AnyObject>>, Retained<NSError>>
NSDictionary and NSError and NSString only.pub fn createSymbolicLinkAtPath_withDestinationPath_error( &self, path: &NSString, dest_path: &NSString, ) -> Result<(), Retained<NSError>>
NSError and NSString only.pub fn destinationOfSymbolicLinkAtPath_error( &self, path: &NSString, ) -> Result<Retained<NSString>, Retained<NSError>>
NSError and NSString only.pub fn copyItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString, ) -> Result<(), Retained<NSError>>
NSError and NSString only.pub fn moveItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString, ) -> Result<(), Retained<NSError>>
NSError and NSString only.pub fn linkItemAtPath_toPath_error( &self, src_path: &NSString, dst_path: &NSString, ) -> Result<(), Retained<NSError>>
NSError and NSString only.pub fn removeItemAtPath_error( &self, path: &NSString, ) -> Result<(), Retained<NSError>>
NSError and NSString only.pub fn copyItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn moveItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn linkItemAtURL_toURL_error( &self, src_url: &NSURL, dst_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn removeItemAtURL_error( &self, url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn trashItemAtURL_resultingItemURL_error( &self, url: &NSURL, out_resulting_url: Option<&mut Option<Retained<NSURL>>>, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn fileAttributesAtPath_traverseLink( &self, path: &NSString, yorn: bool, ) -> Option<Retained<NSDictionary>>
NSDictionary and NSString only.Sourcepub unsafe fn changeFileAttributes_atPath(
&self,
attributes: &NSDictionary,
path: &NSString,
) -> bool
👎Deprecated: Use -setAttributes:ofItemAtPath:error: insteadAvailable on crate features NSDictionary and NSString only.
pub unsafe fn changeFileAttributes_atPath( &self, attributes: &NSDictionary, path: &NSString, ) -> bool
NSDictionary and NSString only.§Safety
attributes generic should be of the correct type.
pub fn directoryContentsAtPath( &self, path: &NSString, ) -> Option<Retained<NSArray>>
NSArray and NSString only.pub fn fileSystemAttributesAtPath( &self, path: &NSString, ) -> Option<Retained<NSDictionary>>
NSDictionary and NSString only.pub fn pathContentOfSymbolicLinkAtPath( &self, path: &NSString, ) -> Option<Retained<NSString>>
NSString only.pub fn createSymbolicLinkAtPath_pathContent( &self, path: &NSString, otherpath: &NSString, ) -> bool
NSString only.Sourcepub unsafe fn createDirectoryAtPath_attributes(
&self,
path: &NSString,
attributes: &NSDictionary,
) -> bool
👎Deprecated: Use -createDirectoryAtPath:withIntermediateDirectories:attributes:error: insteadAvailable on crate features NSDictionary and NSString only.
pub unsafe fn createDirectoryAtPath_attributes( &self, path: &NSString, attributes: &NSDictionary, ) -> bool
NSDictionary and NSString only.§Safety
attributes generic should be of the correct type.
Sourcepub unsafe fn linkPath_toPath_handler(
&self,
src: &NSString,
dest: &NSString,
handler: Option<&AnyObject>,
) -> bool
👎Deprecated: Not supportedAvailable on crate feature NSString only.
pub unsafe fn linkPath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject>, ) -> bool
NSString only.§Safety
handler should be of the correct type.
Sourcepub unsafe fn copyPath_toPath_handler(
&self,
src: &NSString,
dest: &NSString,
handler: Option<&AnyObject>,
) -> bool
👎Deprecated: Not supportedAvailable on crate feature NSString only.
pub unsafe fn copyPath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject>, ) -> bool
NSString only.§Safety
handler should be of the correct type.
Sourcepub unsafe fn movePath_toPath_handler(
&self,
src: &NSString,
dest: &NSString,
handler: Option<&AnyObject>,
) -> bool
👎Deprecated: Not supportedAvailable on crate feature NSString only.
pub unsafe fn movePath_toPath_handler( &self, src: &NSString, dest: &NSString, handler: Option<&AnyObject>, ) -> bool
NSString only.§Safety
handler should be of the correct type.
Sourcepub unsafe fn removeFileAtPath_handler(
&self,
path: &NSString,
handler: Option<&AnyObject>,
) -> bool
👎Deprecated: Not supportedAvailable on crate feature NSString only.
pub unsafe fn removeFileAtPath_handler( &self, path: &NSString, handler: Option<&AnyObject>, ) -> bool
NSString only.§Safety
handler should be of the correct type.
pub fn currentDirectoryPath(&self) -> Retained<NSString>
NSString only.pub fn changeCurrentDirectoryPath(&self, path: &NSString) -> bool
NSString only.pub fn fileExistsAtPath(&self, path: &NSString) -> bool
NSString only.Sourcepub unsafe fn fileExistsAtPath_isDirectory(
&self,
path: &NSString,
is_directory: *mut Bool,
) -> bool
Available on crate feature NSString only.
pub unsafe fn fileExistsAtPath_isDirectory( &self, path: &NSString, is_directory: *mut Bool, ) -> bool
NSString only.§Safety
is_directory must be a valid pointer or null.
pub fn isReadableFileAtPath(&self, path: &NSString) -> bool
NSString only.pub fn isWritableFileAtPath(&self, path: &NSString) -> bool
NSString only.pub fn isExecutableFileAtPath(&self, path: &NSString) -> bool
NSString only.pub fn isDeletableFileAtPath(&self, path: &NSString) -> bool
NSString only.pub fn contentsEqualAtPath_andPath( &self, path1: &NSString, path2: &NSString, ) -> bool
NSString only.pub fn displayNameAtPath(&self, path: &NSString) -> Retained<NSString>
NSString only.pub fn componentsToDisplayForPath( &self, path: &NSString, ) -> Option<Retained<NSArray<NSString>>>
NSArray and NSString only.pub fn enumeratorAtPath( &self, path: &NSString, ) -> Option<Retained<NSDirectoryEnumerator<NSString>>>
NSEnumerator and NSString only.pub 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>>>
NSArray and NSEnumerator and NSError and NSString and NSURL and block2 only.pub fn subpathsAtPath( &self, path: &NSString, ) -> Option<Retained<NSArray<NSString>>>
NSArray and NSString only.pub fn contentsAtPath(&self, path: &NSString) -> Option<Retained<NSData>>
NSData and NSString only.Sourcepub 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 createFileAtPath_contents_attributes( &self, path: &NSString, data: Option<&NSData>, attr: Option<&NSDictionary<NSFileAttributeKey, AnyObject>>, ) -> bool
NSData and NSDictionary and NSString only.§Safety
attr generic should be of the correct type.
pub fn fileSystemRepresentationWithPath( &self, path: &NSString, ) -> NonNull<c_char>
NSString only.Sourcepub unsafe fn stringWithFileSystemRepresentation_length(
&self,
str: NonNull<c_char>,
len: NSUInteger,
) -> Retained<NSString>
Available on crate feature NSString only.
pub unsafe fn stringWithFileSystemRepresentation_length( &self, str: NonNull<c_char>, len: NSUInteger, ) -> Retained<NSString>
NSString only.§Safety
str must be a valid pointer.
pub 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>>
NSError and NSString and NSURL only.pub fn setUbiquitous_itemAtURL_destinationURL_error( &self, flag: bool, url: &NSURL, destination_url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn isUbiquitousItemAtURL(&self, url: &NSURL) -> bool
NSURL only.pub fn startDownloadingUbiquitousItemAtURL_error( &self, url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn evictUbiquitousItemAtURL_error( &self, url: &NSURL, ) -> Result<(), Retained<NSError>>
NSError and NSURL only.pub fn URLForUbiquityContainerIdentifier( &self, container_identifier: Option<&NSString>, ) -> Option<Retained<NSURL>>
NSString and NSURL only.pub fn URLForPublishingUbiquitousItemAtURL_expirationDate_error( &self, url: &NSURL, out_date: Option<&mut Option<Retained<NSDate>>>, ) -> Result<Retained<NSURL>, Retained<NSError>>
NSDate and NSError and NSURL only.pub fn ubiquityIdentityToken(&self) -> Option<Retained<AnyObject>>
NSObject only.Sourcepub unsafe fn pauseSyncForUbiquitousItemAtURL_completionHandler(
&self,
url: &NSURL,
completion_handler: &DynBlock<dyn Fn(*mut NSError)>,
)
Available on crate features NSError and NSURL and block2 only.
pub unsafe fn pauseSyncForUbiquitousItemAtURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )
NSError and NSURL and block2 only.Asynchronously pauses sync of an item at the given URL.
Call this when opening an item to prevent sync from altering the contents of the URL. Once paused, the file provider will not upload local changes nor download remote changes.
While paused, call uploadLocalVersionOfUbiquitousItem(at:withConflictResolutionPolicy:completionHandler:) when the document is in a stable state.
This action keeps the server version as up-to-date as possible.
If the item is already paused, a second call to this method reports success.
If the file provider is already applying changes to the item, the pause fails with an NSFileWriteUnknownError-enum.case, with an underlying error that has domain NSPOSIXErrorDomain and code POSIXError/EBUSY.
If the pause fails, wait for the state to stabilize before retrying.
Pausing also fails with CocoaError/featureUnsupported if url refers to a regular (non-package) directory.
Pausing sync is independent of the calling app’s lifecycle; sync doesn’t automatically resume if the app closes or crashes and relaunches later.
To resume syncing, explicitly call resumeSyncForUbiquitousItem(at:with:completionHandler:).
Always be sure to resume syncing before you close the item.
- Parameters:
- url: The URL of the item for which to pause sync.
- completionHandler: A closure or block that the framework calls when the pause action completes. It receives a single
NSErrorparameter to indicate an error that prevented pausing; this value isnilif the pause succeeded. In Swift, you can omit the completion handler and catch the thrown error instead.
§Safety
completion_handler block must be sendable.
Sourcepub unsafe fn resumeSyncForUbiquitousItemAtURL_withBehavior_completionHandler(
&self,
url: &NSURL,
behavior: NSFileManagerResumeSyncBehavior,
completion_handler: &DynBlock<dyn Fn(*mut NSError)>,
)
Available on crate features NSError and NSURL and block2 only.
pub unsafe fn resumeSyncForUbiquitousItemAtURL_withBehavior_completionHandler( &self, url: &NSURL, behavior: NSFileManagerResumeSyncBehavior, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )
NSError and NSURL and block2 only.Asynchronously resumes the sync on a paused item using the given resume behavior.
Always call this method when your app closes an item to allow the file provider to sync local changes back to the server.
In most situations, the NSFileManagerResumeSyncBehavior/preserveLocalChanges behavior is the best choice to avoid any risk of data loss.
The resume call fails with CocoaError/featureUnsupported if url isn’t currently paused.
If the device isn’t connected to the network, the call may fail with NSFileWriteUnknownError-enum.case, with the underlying error of
<doc
://com.apple.documentation/documentation/FileProvider/NSFileProviderError/serverUnreachable>.
- Parameters:
- url: The URL of the item for which to resume sync.
- behavior: A
NSFileManagerResumeSyncBehaviorvalue that tells the file manager how to handle conflicts between local and remote versions of files. - completionHandler: A closure or block that the framework calls when the resume action completes. It receives a single
NSErrorparameter to indicate an error that prevented the resume action; the value isnilif the resume succeeded. In Swift, you can omit the completion handler and catch the thrown error instead.
§Safety
completion_handler block must be sendable.
Sourcepub unsafe fn fetchLatestRemoteVersionOfItemAtURL_completionHandler(
&self,
url: &NSURL,
completion_handler: &DynBlock<dyn Fn(*mut NSFileVersion, *mut NSError)>,
)
Available on crate features NSError and NSFileVersion and NSURL and block2 only.
pub unsafe fn fetchLatestRemoteVersionOfItemAtURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSFileVersion, *mut NSError)>, )
NSError and NSFileVersion and NSURL and block2 only.Asynchronously fetches the latest remote version of a given item from the server.
Use this method if uploading fails due to a version conflict and sync is paused. In this case, fetching the latest remote version allows you to inspect the newer item from the server, resolve the conflict, and resume uploading.
The version provided by this call depends on several factors:
- If there is no newer version of the file on the server, the caller receives the current version of the file.
- If the server has a newer version and sync isn’t paused, this call replaces the local item and provides the version of the new item.
- If the server has a newer version but sync is paused, the returned version points to a side location. In this case, call
NSFileVersion/replaceItem(at:options:)on the provided version object to replace the local item with the newer item from the server.
If the device isn’t connected to the network, the call may fail with NSFileReadUnknownError-enum.case, with the underlying error of
<doc
://com.apple.documentation/documentation/FileProvider/NSFileProviderError/serverUnreachable>.
- Parameters:
- url: The URL of the item for which to check the version.
- completionHandler: A closure or block that the framework calls when the fetch action completes. It receives parameters of types
NSFileVersionandNSError. The error isnilif fetching the remote version succeeded; otherwise it indicates the error that caused the call to fail. In Swift, you can omit the completion handler, catching any error in ado-catchblock and receiving the version as the return value.
§Safety
completion_handler block must be sendable.
Sourcepub unsafe fn uploadLocalVersionOfUbiquitousItemAtURL_withConflictResolutionPolicy_completionHandler(
&self,
url: &NSURL,
conflict_resolution_policy: NSFileManagerUploadLocalVersionConflictPolicy,
completion_handler: &DynBlock<dyn Fn(*mut NSFileVersion, *mut NSError)>,
)
Available on crate features NSError and NSFileVersion and NSURL and block2 only.
pub unsafe fn uploadLocalVersionOfUbiquitousItemAtURL_withConflictResolutionPolicy_completionHandler( &self, url: &NSURL, conflict_resolution_policy: NSFileManagerUploadLocalVersionConflictPolicy, completion_handler: &DynBlock<dyn Fn(*mut NSFileVersion, *mut NSError)>, )
NSError and NSFileVersion and NSURL and block2 only.Asynchronously uploads the local version of the item using the provided conflict resolution policy.
Once your app pauses a sync for an item, call this method every time your document is in a stable state. This action keeps the server version as up-to-date as possible.
If the server has a newer version than the one to which the app made changes, uploading fails with NSFileWriteUnknownError-enum.case, with an underlying error of
<doc
://com.apple.documentation/documentation/FileProvider/NSFileProviderError/localVersionConflictingWithServer>.
In this case, call FileManager/fetchLatestRemoteVersionOfItem(at:completionHandler:), rebase local changes on top of that version, and retry the upload.
If the device isn’t connected to the network, the call may fail with NSFileWriteUnknownError-enum.case, with the underlying error of
<doc
://com.apple.documentation/documentation/FileProvider/NSFileProviderError/serverUnreachable>.
- Parameters:
- url: The URL of the item for which to check the version.
- conflictResolutionPolicy: The policy the file manager applies if the local and server versions conflict.
- completionHandler: A closure or block that the framework calls when the upload completes. It receives parameters of types
NSFileVersionandNSError. The error isnilif fetching the remote version succeeded; otherwise it indicates the error that caused the call to fail. In Swift, you can omit the completion handler, catching any error in ado-catchblock and receiving the version as the return value.
§Safety
completion_handler block must be sendable.
Sourcepub 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 getFileProviderServicesForItemAtURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSFileProviderServiceName, NSFileProviderService>, *mut NSError)>, )
NSDictionary and NSError and NSString and NSURL and block2 only.§Safety
completion_handler block must be sendable.
pub fn containerURLForSecurityApplicationGroupIdentifier( &self, group_identifier: &NSString, ) -> Option<Retained<NSURL>>
NSString and NSURL only.Source§impl NSFileManager
Methods declared on superclass NSObject.
impl NSFileManager
Methods declared on superclass NSObject.
Source§impl NSFileManager
NSUserInformation.
impl NSFileManager
NSUserInformation.
pub fn homeDirectoryForCurrentUser(&self) -> Retained<NSURL>
NSURL only.pub fn temporaryDirectory(&self) -> Retained<NSURL>
NSURL only.pub fn homeDirectoryForUser( &self, user_name: &NSString, ) -> Option<Retained<NSURL>>
NSString and NSURL only.Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for NSFileManager
impl AsRef<AnyObject> for NSFileManager
Source§impl AsRef<NSFileManager> for NSFileManager
impl AsRef<NSFileManager> for NSFileManager
Source§impl AsRef<NSObject> for NSFileManager
impl AsRef<NSObject> for NSFileManager
Source§impl Borrow<AnyObject> for NSFileManager
impl Borrow<AnyObject> for NSFileManager
Source§impl Borrow<NSObject> for NSFileManager
impl Borrow<NSObject> for NSFileManager
Source§impl ClassType for NSFileManager
impl ClassType for NSFileManager
Source§const NAME: &'static str = "NSFileManager"
const NAME: &'static str = "NSFileManager"
Source§type ThreadKind = <<NSFileManager as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSFileManager as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for NSFileManager
impl Debug for NSFileManager
Source§impl DefaultRetained for NSFileManager
impl DefaultRetained for NSFileManager
Source§impl Deref for NSFileManager
impl Deref for NSFileManager
Source§impl Hash for NSFileManager
impl Hash for NSFileManager
Source§impl Message for NSFileManager
impl Message for NSFileManager
Source§impl NSObjectProtocol for NSFileManager
impl NSObjectProtocol for NSFileManager
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass directly, or cast your objects with AnyObject::downcast_ref