Struct NSFileProviderErrorCode

#[repr(transparent)]
pub struct NSFileProviderErrorCode(pub NSInteger);

Available on crate feature NSFileProviderError only.

Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl NSFileProviderErrorCode

pub const NotAuthenticated: Self

The user credentials cannot be verified

pub const FilenameCollision: Self

An item already exists with the same parentItemIdentifier and filename (or with a filename differing only in case.)

Note: Please use -[NSError (NSFileProviderError) fileProviderErrorForCollisionWithItem:] to build an error with this code.

See: -[NSError (NSFileProviderError) fileProviderErrorForCollisionWithItem:]

pub const SyncAnchorExpired: Self

The value of the sync anchor is too old, and the system must re-sync from scratch

pub const PageExpired: Self

The value of the page token is too old, and the system must re-sync from scratch

pub const InsufficientQuota: Self

The item has not been uploaded because it would push the account over quota

pub const ServerUnreachable: Self

Connecting to the servers failed

pub const NoSuchItem: Self

The requested item doesn’t exist

Note: Please use -[NSError (NSFileProviderError) fileProviderErrorForNonExistentItemWithIdentifier:] to build an error with this code.

See: -[NSError (NSFileProviderError) fileProviderErrorForNonExistentItemWithIdentifier:]

pub const DeletionRejected: Self

The provider disallowed the deletion of the item.

Note: Please use -[NSError (NSFileProviderError) fileProviderErrorForRejectedDeletionOfItem:] to build an error with this code.

See: -[NSError (NSFileProviderError) fileProviderErrorForRejectedDeletionOfItem:]

pub const DirectoryNotEmpty: Self

We’re trying to non-recursively delete a non-empty directory

pub const ProviderNotFound: Self

Returned by NSFileProviderManager if no provider could be found in the application

pub const ProviderTranslocated: Self

Returned by NSFileProviderManager if the application’s provider has been disabled due to app translocation

pub const OlderExtensionVersionRunning: Self

Returned by NSFileProviderManager if the provider registered in the system is an older version than the one corresponding to this app. The NSFilePathErrorKey key points to the location of the older version. If the location of the older version cannot be determined (e.g. because it was since deleted), the NSFilePathErrorKey will not be set.

pub const NewerExtensionVersionFound: Self

Returned by NSFileProviderManager if the provider registered in the system is a newer version than the one corresponding to this app.

pub const CannotSynchronize: Self

Indicates that synchronization cannot happen.

This error can be returned by the provider or the system.

This is returned by NSFileProviderManager if a barrier failed for a sync-related error.

If the failure is caused by a specific item, the system will set the NSFileProviderErrorItemKey to the corresponding item identifier and the NSUnderlyingErrorKey will be set to the error encountered by that item.

When a provider returns this error on createItem or updateItem, it means that syncing that item is definitively broken. The system will not retry syncing those items, until either: The operating system has been updated. The FileProvider extension has been updated. The item is modified on disk.

pub const NonEvictableChildren: Self

Returned by NSFileProviderManager if directory eviction failed because the target contains non-evictable items.

-[NSError underlyingErrors] is set to an array of the underlying errors. Each one has NSURLErrorKey set to identify the particular file or directory affected by this error. The number of reported failing items is capped to an implementation-defined number.

• domain: NSFileProviderErrorDomain errorCode: NSFileProviderErrorUnsyncedEdits error: if the item had unsynced content.
• domain: NSFileProviderErrorDomain errorCode: NSFileProviderErrorNonEvictable error: if the item has been marked as non-purgeable by the provider.
• domain: NSPOSIXErrorDomain errorCode: EBUSY - if the item had open file descriptors on it.
• domain: NSPOSIXErrorDomain errorCode: EMLINK : if the item had several hardlinks.

pub const UnsyncedEdits: Self

Returned by NSFileProviderManager if item eviction is failing because the item has edits that have not been synced yet

The NSURLErrorKey will be set to with the item URL that has unsynced content.

pub const NonEvictable: Self

Returned by NSFileProviderManager if item eviction is failing because the item has not been assigned the evictable capability.

The NSURLErrorKey will be set to with the corresponding item URL.

pub const VersionNoLongerAvailable: Self

Returned by the provider to indicate that the requested version for an item cannot be provided.

When a provider returns that error, it means the version for this item is definitively unavailable. It is intended to be returned by fetchPartialContentsForItemWithIdentifier, when NSFileProviderFetchContentsOptionsStrictVersioning is set, to tell the system that a remote update happened to the item that outdated the requested version.

pub const ExcludedFromSync: Self

Returned by createItemBasedOnTemplate or modifyItem if the provider does not wish to sync the item.

When a provider returns this error, it causes the item to be excluded from sync. The system will ensure that the item (and any descendents, in case of a directory), are downloaded, and then issue a deleteItem call to the provider for the item.

The system will call createItemBasedOnTemplate for the item, whenever the item’s metadata changes on disk. This ensures that the provider’s rules for excluding from sync are re-evaluated whenever the item’s properties change.

Re-evaluating items

If the provider wishes for previously excluded items to be re-sent as createItemBasedOnTemplate calls, the provider may call -[NSFileProviderManager signalErrorResolved:completionHandler:] with this error code.

If the provider wishes to exclude items which had previously been synced, the provider may call -[NSFileProviderManager requestModificationOfFields:forItemWithIdentifier:options:completionHandler:]. This will cause the system to send a new modifyItem call to the provider. At that time, the provider can choose to return this error code.

pub const DomainDisabled: Self

Returned by createItemBasedOnTemplate or modifyItem if the provider does not wish to sync the item.

When a provider returns this error, it causes the item to be excluded from sync. The system will ensure that the item (and any descendents, in case of a directory), are downloaded, and then issue a deleteItem call to the provider for the item.

The system will call createItemBasedOnTemplate for the item, whenever the item’s metadata changes on disk. This ensures that the provider’s rules for excluding from sync are re-evaluated whenever the item’s properties change.

Re-evaluating items

If the provider wishes for previously excluded items to be re-sent as createItemBasedOnTemplate calls, the provider may call -[NSFileProviderManager signalErrorResolved:completionHandler:] with this error code.

If the provider wishes to exclude items which had previously been synced, the provider may call -[NSFileProviderManager requestModificationOfFields:forItemWithIdentifier:options:completionHandler:]. This will cause the system to send a new modifyItem call to the provider. At that time, the provider can choose to return this error code.

pub const ProviderDomainTemporarilyUnavailable: Self

Returned by createItemBasedOnTemplate or modifyItem if the provider does not wish to sync the item.

When a provider returns this error, it causes the item to be excluded from sync. The system will ensure that the item (and any descendents, in case of a directory), are downloaded, and then issue a deleteItem call to the provider for the item.

The system will call createItemBasedOnTemplate for the item, whenever the item’s metadata changes on disk. This ensures that the provider’s rules for excluding from sync are re-evaluated whenever the item’s properties change.

Re-evaluating items

If the provider wishes for previously excluded items to be re-sent as createItemBasedOnTemplate calls, the provider may call -[NSFileProviderManager signalErrorResolved:completionHandler:] with this error code.

If the provider wishes to exclude items which had previously been synced, the provider may call -[NSFileProviderManager requestModificationOfFields:forItemWithIdentifier:options:completionHandler:]. This will cause the system to send a new modifyItem call to the provider. At that time, the provider can choose to return this error code.

pub const ProviderDomainNotFound: Self

Returned by createItemBasedOnTemplate or modifyItem if the provider does not wish to sync the item.

When a provider returns this error, it causes the item to be excluded from sync. The system will ensure that the item (and any descendents, in case of a directory), are downloaded, and then issue a deleteItem call to the provider for the item.

The system will call createItemBasedOnTemplate for the item, whenever the item’s metadata changes on disk. This ensures that the provider’s rules for excluding from sync are re-evaluated whenever the item’s properties change.

Re-evaluating items

If the provider wishes for previously excluded items to be re-sent as createItemBasedOnTemplate calls, the provider may call -[NSFileProviderManager signalErrorResolved:completionHandler:] with this error code.

If the provider wishes to exclude items which had previously been synced, the provider may call -[NSFileProviderManager requestModificationOfFields:forItemWithIdentifier:options:completionHandler:]. This will cause the system to send a new modifyItem call to the provider. At that time, the provider can choose to return this error code.

pub const ApplicationExtensionNotFound: Self

Returned by createItemBasedOnTemplate or modifyItem if the provider does not wish to sync the item.

When a provider returns this error, it causes the item to be excluded from sync. The system will ensure that the item (and any descendents, in case of a directory), are downloaded, and then issue a deleteItem call to the provider for the item.

The system will call createItemBasedOnTemplate for the item, whenever the item’s metadata changes on disk. This ensures that the provider’s rules for excluding from sync are re-evaluated whenever the item’s properties change.

Re-evaluating items

If the provider wishes for previously excluded items to be re-sent as createItemBasedOnTemplate calls, the provider may call -[NSFileProviderManager signalErrorResolved:completionHandler:] with this error code.

If the provider wishes to exclude items which had previously been synced, the provider may call -[NSFileProviderManager requestModificationOfFields:forItemWithIdentifier:options:completionHandler:]. This will cause the system to send a new modifyItem call to the provider. At that time, the provider can choose to return this error code.

Trait Implementations

impl Clone for NSFileProviderErrorCode

fn clone(&self) -> NSFileProviderErrorCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NSFileProviderErrorCode

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

Formats the value using the given formatter.

impl Encode for NSFileProviderErrorCode

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for NSFileProviderErrorCode

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 Ord for NSFileProviderErrorCode

fn cmp(&self, other: &NSFileProviderErrorCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NSFileProviderErrorCode

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

fn partial_cmp(&self, other: &NSFileProviderErrorCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for NSFileProviderErrorCode

const ENCODING_REF: Encoding

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

impl Copy for NSFileProviderErrorCode

impl Eq for NSFileProviderErrorCode

impl StructuralPartialEq for NSFileProviderErrorCode