objc2_home_kit/generated/
HMError.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2::__framework_prelude::*;
5use objc2_foundation::*;
6
7use crate::*;
8
9extern "C" {
10    /// [Apple's documentation](https://developer.apple.com/documentation/homekit/hmerrordomain?language=objc)
11    pub static HMErrorDomain: &'static NSString;
12}
13
14/// This enumeration describes the possible error constants that can be
15/// returned from the the HomeKit APIs.
16///
17/// See also [Apple's documentation](https://developer.apple.com/documentation/homekit/hmerrorcode?language=objc)
18// NS_ENUM
19#[repr(transparent)]
20#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
21pub struct HMErrorCode(pub NSInteger);
22impl HMErrorCode {
23    #[doc(alias = "HMErrorCodeUnexpectedError")]
24    pub const UnexpectedError: Self = Self(-1);
25    #[doc(alias = "HMErrorCodeAlreadyExists")]
26    pub const AlreadyExists: Self = Self(1);
27    #[doc(alias = "HMErrorCodeNotFound")]
28    pub const NotFound: Self = Self(2);
29    #[doc(alias = "HMErrorCodeInvalidParameter")]
30    pub const InvalidParameter: Self = Self(3);
31    #[doc(alias = "HMErrorCodeAccessoryNotReachable")]
32    pub const AccessoryNotReachable: Self = Self(4);
33    #[doc(alias = "HMErrorCodeReadOnlyCharacteristic")]
34    pub const ReadOnlyCharacteristic: Self = Self(5);
35    #[doc(alias = "HMErrorCodeWriteOnlyCharacteristic")]
36    pub const WriteOnlyCharacteristic: Self = Self(6);
37    #[doc(alias = "HMErrorCodeNotificationNotSupported")]
38    pub const NotificationNotSupported: Self = Self(7);
39    #[doc(alias = "HMErrorCodeOperationTimedOut")]
40    pub const OperationTimedOut: Self = Self(8);
41    #[doc(alias = "HMErrorCodeAccessoryPoweredOff")]
42    pub const AccessoryPoweredOff: Self = Self(9);
43    #[doc(alias = "HMErrorCodeAccessDenied")]
44    pub const AccessDenied: Self = Self(10);
45    #[doc(alias = "HMErrorCodeObjectAssociatedToAnotherHome")]
46    pub const ObjectAssociatedToAnotherHome: Self = Self(11);
47    #[doc(alias = "HMErrorCodeObjectNotAssociatedToAnyHome")]
48    pub const ObjectNotAssociatedToAnyHome: Self = Self(12);
49    #[doc(alias = "HMErrorCodeObjectAlreadyAssociatedToHome")]
50    pub const ObjectAlreadyAssociatedToHome: Self = Self(13);
51    #[doc(alias = "HMErrorCodeAccessoryIsBusy")]
52    pub const AccessoryIsBusy: Self = Self(14);
53    #[doc(alias = "HMErrorCodeOperationInProgress")]
54    pub const OperationInProgress: Self = Self(15);
55    #[doc(alias = "HMErrorCodeAccessoryOutOfResources")]
56    pub const AccessoryOutOfResources: Self = Self(16);
57    #[doc(alias = "HMErrorCodeInsufficientPrivileges")]
58    pub const InsufficientPrivileges: Self = Self(17);
59    #[doc(alias = "HMErrorCodeAccessoryPairingFailed")]
60    pub const AccessoryPairingFailed: Self = Self(18);
61    #[doc(alias = "HMErrorCodeInvalidDataFormatSpecified")]
62    pub const InvalidDataFormatSpecified: Self = Self(19);
63    #[doc(alias = "HMErrorCodeNilParameter")]
64    pub const NilParameter: Self = Self(20);
65    #[doc(alias = "HMErrorCodeUnconfiguredParameter")]
66    pub const UnconfiguredParameter: Self = Self(21);
67    #[doc(alias = "HMErrorCodeInvalidClass")]
68    pub const InvalidClass: Self = Self(22);
69    #[doc(alias = "HMErrorCodeOperationCancelled")]
70    pub const OperationCancelled: Self = Self(23);
71    #[doc(alias = "HMErrorCodeRoomForHomeCannotBeInZone")]
72    pub const RoomForHomeCannotBeInZone: Self = Self(24);
73    #[doc(alias = "HMErrorCodeNoActionsInActionSet")]
74    pub const NoActionsInActionSet: Self = Self(25);
75    #[doc(alias = "HMErrorCodeNoRegisteredActionSets")]
76    pub const NoRegisteredActionSets: Self = Self(26);
77    #[doc(alias = "HMErrorCodeMissingParameter")]
78    pub const MissingParameter: Self = Self(27);
79    #[doc(alias = "HMErrorCodeFireDateInPast")]
80    pub const FireDateInPast: Self = Self(28);
81    #[doc(alias = "HMErrorCodeRoomForHomeCannotBeUpdated")]
82    pub const RoomForHomeCannotBeUpdated: Self = Self(29);
83    #[doc(alias = "HMErrorCodeActionInAnotherActionSet")]
84    pub const ActionInAnotherActionSet: Self = Self(30);
85    #[doc(alias = "HMErrorCodeObjectWithSimilarNameExistsInHome")]
86    pub const ObjectWithSimilarNameExistsInHome: Self = Self(31);
87    #[doc(alias = "HMErrorCodeHomeWithSimilarNameExists")]
88    pub const HomeWithSimilarNameExists: Self = Self(32);
89    #[doc(alias = "HMErrorCodeRenameWithSimilarName")]
90    pub const RenameWithSimilarName: Self = Self(33);
91    #[doc(alias = "HMErrorCodeCannotRemoveNonBridgeAccessory")]
92    pub const CannotRemoveNonBridgeAccessory: Self = Self(34);
93    #[doc(alias = "HMErrorCodeNameContainsProhibitedCharacters")]
94    pub const NameContainsProhibitedCharacters: Self = Self(35);
95    #[doc(alias = "HMErrorCodeNameDoesNotStartWithValidCharacters")]
96    pub const NameDoesNotStartWithValidCharacters: Self = Self(36);
97    #[doc(alias = "HMErrorCodeUserIDNotEmailAddress")]
98    pub const UserIDNotEmailAddress: Self = Self(37);
99    #[doc(alias = "HMErrorCodeUserDeclinedAddingUser")]
100    pub const UserDeclinedAddingUser: Self = Self(38);
101    #[doc(alias = "HMErrorCodeUserDeclinedRemovingUser")]
102    pub const UserDeclinedRemovingUser: Self = Self(39);
103    #[doc(alias = "HMErrorCodeUserDeclinedInvite")]
104    pub const UserDeclinedInvite: Self = Self(40);
105    #[doc(alias = "HMErrorCodeUserManagementFailed")]
106    pub const UserManagementFailed: Self = Self(41);
107    #[doc(alias = "HMErrorCodeRecurrenceTooSmall")]
108    pub const RecurrenceTooSmall: Self = Self(42);
109    #[doc(alias = "HMErrorCodeInvalidValueType")]
110    pub const InvalidValueType: Self = Self(43);
111    #[doc(alias = "HMErrorCodeValueLowerThanMinimum")]
112    pub const ValueLowerThanMinimum: Self = Self(44);
113    #[doc(alias = "HMErrorCodeValueHigherThanMaximum")]
114    pub const ValueHigherThanMaximum: Self = Self(45);
115    #[doc(alias = "HMErrorCodeStringLongerThanMaximum")]
116    pub const StringLongerThanMaximum: Self = Self(46);
117    #[doc(alias = "HMErrorCodeHomeAccessNotAuthorized")]
118    pub const HomeAccessNotAuthorized: Self = Self(47);
119    #[doc(alias = "HMErrorCodeOperationNotSupported")]
120    pub const OperationNotSupported: Self = Self(48);
121    #[doc(alias = "HMErrorCodeMaximumObjectLimitReached")]
122    pub const MaximumObjectLimitReached: Self = Self(49);
123    #[doc(alias = "HMErrorCodeAccessorySentInvalidResponse")]
124    pub const AccessorySentInvalidResponse: Self = Self(50);
125    #[doc(alias = "HMErrorCodeStringShorterThanMinimum")]
126    pub const StringShorterThanMinimum: Self = Self(51);
127    #[doc(alias = "HMErrorCodeGenericError")]
128    pub const GenericError: Self = Self(52);
129    #[doc(alias = "HMErrorCodeSecurityFailure")]
130    pub const SecurityFailure: Self = Self(53);
131    #[doc(alias = "HMErrorCodeCommunicationFailure")]
132    pub const CommunicationFailure: Self = Self(54);
133    #[doc(alias = "HMErrorCodeMessageAuthenticationFailed")]
134    pub const MessageAuthenticationFailed: Self = Self(55);
135    #[doc(alias = "HMErrorCodeInvalidMessageSize")]
136    pub const InvalidMessageSize: Self = Self(56);
137    #[doc(alias = "HMErrorCodeAccessoryDiscoveryFailed")]
138    pub const AccessoryDiscoveryFailed: Self = Self(57);
139    #[doc(alias = "HMErrorCodeClientRequestError")]
140    pub const ClientRequestError: Self = Self(58);
141    #[doc(alias = "HMErrorCodeAccessoryResponseError")]
142    pub const AccessoryResponseError: Self = Self(59);
143    #[doc(alias = "HMErrorCodeNameDoesNotEndWithValidCharacters")]
144    pub const NameDoesNotEndWithValidCharacters: Self = Self(60);
145    #[doc(alias = "HMErrorCodeAccessoryIsBlocked")]
146    pub const AccessoryIsBlocked: Self = Self(61);
147    #[doc(alias = "HMErrorCodeInvalidAssociatedServiceType")]
148    pub const InvalidAssociatedServiceType: Self = Self(62);
149    #[doc(alias = "HMErrorCodeActionSetExecutionFailed")]
150    pub const ActionSetExecutionFailed: Self = Self(63);
151    #[doc(alias = "HMErrorCodeActionSetExecutionPartialSuccess")]
152    pub const ActionSetExecutionPartialSuccess: Self = Self(64);
153    #[doc(alias = "HMErrorCodeActionSetExecutionInProgress")]
154    pub const ActionSetExecutionInProgress: Self = Self(65);
155    #[doc(alias = "HMErrorCodeAccessoryOutOfCompliance")]
156    pub const AccessoryOutOfCompliance: Self = Self(66);
157    #[doc(alias = "HMErrorCodeDataResetFailure")]
158    pub const DataResetFailure: Self = Self(67);
159    #[doc(alias = "HMErrorCodeNotificationAlreadyEnabled")]
160    pub const NotificationAlreadyEnabled: Self = Self(68);
161    #[doc(alias = "HMErrorCodeRecurrenceMustBeOnSpecifiedBoundaries")]
162    pub const RecurrenceMustBeOnSpecifiedBoundaries: Self = Self(69);
163    #[doc(alias = "HMErrorCodeDateMustBeOnSpecifiedBoundaries")]
164    pub const DateMustBeOnSpecifiedBoundaries: Self = Self(70);
165    #[doc(alias = "HMErrorCodeCannotActivateTriggerTooFarInFuture")]
166    pub const CannotActivateTriggerTooFarInFuture: Self = Self(71);
167    #[doc(alias = "HMErrorCodeRecurrenceTooLarge")]
168    pub const RecurrenceTooLarge: Self = Self(72);
169    #[doc(alias = "HMErrorCodeReadWritePartialSuccess")]
170    pub const ReadWritePartialSuccess: Self = Self(73);
171    #[doc(alias = "HMErrorCodeReadWriteFailure")]
172    pub const ReadWriteFailure: Self = Self(74);
173    #[doc(alias = "HMErrorCodeNotSignedIntoiCloud")]
174    pub const NotSignedIntoiCloud: Self = Self(75);
175    #[doc(alias = "HMErrorCodeKeychainSyncNotEnabled")]
176    pub const KeychainSyncNotEnabled: Self = Self(76);
177    #[doc(alias = "HMErrorCodeCloudDataSyncInProgress")]
178    pub const CloudDataSyncInProgress: Self = Self(77);
179    #[doc(alias = "HMErrorCodeNetworkUnavailable")]
180    pub const NetworkUnavailable: Self = Self(78);
181    #[doc(alias = "HMErrorCodeAddAccessoryFailed")]
182    pub const AddAccessoryFailed: Self = Self(79);
183    #[doc(alias = "HMErrorCodeMissingEntitlement")]
184    pub const MissingEntitlement: Self = Self(80);
185    #[doc(alias = "HMErrorCodeCannotUnblockNonBridgeAccessory")]
186    pub const CannotUnblockNonBridgeAccessory: Self = Self(81);
187    #[doc(alias = "HMErrorCodeDeviceLocked")]
188    pub const DeviceLocked: Self = Self(82);
189    #[doc(alias = "HMErrorCodeCannotRemoveBuiltinActionSet")]
190    pub const CannotRemoveBuiltinActionSet: Self = Self(83);
191    #[doc(alias = "HMErrorCodeLocationForHomeDisabled")]
192    pub const LocationForHomeDisabled: Self = Self(84);
193    #[doc(alias = "HMErrorCodeNotAuthorizedForLocationServices")]
194    pub const NotAuthorizedForLocationServices: Self = Self(85);
195    #[doc(alias = "HMErrorCodeReferToUserManual")]
196    pub const ReferToUserManual: Self = Self(86);
197    #[doc(alias = "HMErrorCodeInvalidOrMissingAuthorizationData")]
198    pub const InvalidOrMissingAuthorizationData: Self = Self(87);
199    #[doc(alias = "HMErrorCodeBridgedAccessoryNotReachable")]
200    pub const BridgedAccessoryNotReachable: Self = Self(88);
201    #[doc(alias = "HMErrorCodeNotAuthorizedForMicrophoneAccess")]
202    pub const NotAuthorizedForMicrophoneAccess: Self = Self(89);
203    #[doc(alias = "HMErrorCodeIncompatibleNetwork")]
204    pub const IncompatibleNetwork: Self = Self(90);
205    #[doc(alias = "HMErrorCodeNoHomeHub")]
206    pub const NoHomeHub: Self = Self(91);
207    #[doc(alias = "HMErrorCodeNoCompatibleHomeHub")]
208    pub const NoCompatibleHomeHub: Self = Self(92);
209    #[doc(alias = "HMErrorCodeIncompatibleAccessory")]
210    pub const IncompatibleAccessory: Self = Self(93);
211    #[doc(alias = "HMErrorCodeIncompatibleHomeHub")]
212    #[deprecated]
213    pub const IncompatibleHomeHub: Self = Self(HMErrorCode::NoCompatibleHomeHub.0);
214    #[doc(alias = "HMErrorCodeObjectWithSimilarNameExists")]
215    pub const ObjectWithSimilarNameExists: Self = Self(95);
216    #[doc(alias = "HMErrorCodeOwnershipFailure")]
217    pub const OwnershipFailure: Self = Self(96);
218    #[doc(alias = "HMErrorCodeMaximumAccessoriesOfTypeInHome")]
219    pub const MaximumAccessoriesOfTypeInHome: Self = Self(97);
220    #[doc(alias = "HMErrorCodeWiFiCredentialGenerationFailed")]
221    pub const WiFiCredentialGenerationFailed: Self = Self(98);
222    #[doc(alias = "HMErrorCodeEnterpriseNetworkNotSupported")]
223    pub const EnterpriseNetworkNotSupported: Self = Self(99);
224    #[doc(alias = "HMErrorCodeTimedOutWaitingForAccessory")]
225    pub const TimedOutWaitingForAccessory: Self = Self(100);
226    #[doc(alias = "HMErrorCodeAccessoryCommunicationFailure")]
227    pub const AccessoryCommunicationFailure: Self = Self(101);
228    #[doc(alias = "HMErrorCodeFailedToJoinNetwork")]
229    pub const FailedToJoinNetwork: Self = Self(102);
230    #[doc(alias = "HMErrorCodeAccessoryIsSuspended")]
231    pub const AccessoryIsSuspended: Self = Self(103);
232    #[doc(alias = "HMErrorCodePartialCommunicationFailure")]
233    pub const PartialCommunicationFailure: Self = Self(104);
234    #[doc(alias = "HMErrorCodeHomeUpgradeRequired")]
235    pub const HomeUpgradeRequired: Self = Self(105);
236}
237
238unsafe impl Encode for HMErrorCode {
239    const ENCODING: Encoding = NSInteger::ENCODING;
240}
241
242unsafe impl RefEncode for HMErrorCode {
243    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
244}