2020-03-23 15:06:58 -07:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Enumerations Reference< / title >
< link rel = "stylesheet" type = "text/css" href = "css/jazzy.css" / >
< link rel = "stylesheet" type = "text/css" href = "css/highlight.css" / >
< meta charset = 'utf-8' >
< script src = "js/jquery.min.js" defer > < / script >
< script src = "js/jazzy.js" defer > < / script >
< / head >
< body >
< a name = "//apple_ref/swift/Section/Enumerations" class = "dashAnchor" > < / a >
< a title = "Enumerations Reference" > < / a >
< header >
< div class = "content-wrapper" >
2020-04-06 10:06:13 -07:00
< p > < a href = "index.html" > ZcashLightClientKit Docs< / a > (71% documented)< / p >
2020-03-23 15:06:58 -07:00
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "index.html" > ZcashLightClientKit Reference< / a >
< img id = "carat" src = "img/carat.png" / >
Enumerations Reference
< / p >
< / div >
< div class = "content-wrapper" >
< nav class = "sidebar" >
< ul class = "nav-groups" >
< li class = "nav-group-name" >
< a href = "Classes.html" > Classes< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Classes/CompactBlockProcessor.html" > CompactBlockProcessor< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/CompactBlockProcessor/Configuration.html" > – Configuration< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/CompactBlockProcessor/State.html" > – State< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/Initializer.html" > Initializer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/LightWalletGRPCService.html" > LightWalletGRPCService< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/SDKSynchronizer.html" > SDKSynchronizer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/SDKSynchronizer/NotificationKeys.html" > – NotificationKeys< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/ZcashSDK.html" > ZcashSDK< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Enums.html" > Enumerations< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Enums/CompactBlockProcessorError.html" > CompactBlockProcessorError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/InitializerError.html" > InitializerError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/LightWalletServiceError.html" > LightWalletServiceError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/ResourceProviderError.html" > ResourceProviderError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/RustWeldingError.html" > RustWeldingError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/Status.html" > Status< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/SynchronizerError.html" > SynchronizerError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/TransactionEncoderError.html" > TransactionEncoderError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Enums/TransactionKind.html" > TransactionKind< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Extensions.html" > Extensions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Extensions/Array.html" > Array< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/BlockHeight.html" > BlockHeight< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Collection.html" > Collection< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/CompactBlockRange.html" > CompactBlockRange< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Data.html" > Data< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Data/HexEncodingOptions.html" > – HexEncodingOptions< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Notification.html" > Notification< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Notification/Name.html" > – Name< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/String.html" > String< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Protocols.html" > Protocols< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Protocols/AbstractTransaction.html" > AbstractTransaction< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/CompactBlockDownloading.html" > CompactBlockDownloading< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/ConfirmedTransactionEntity.html" > ConfirmedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/LightWalletService.html" > LightWalletService< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/LightWalletServiceResponse.html" > LightWalletServiceResponse< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/Logger.html" > Logger< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/MinedTransactionEntity.html" > MinedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/PaginatedTransactionRepository.html" > PaginatedTransactionRepository< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/PendingTransactionEntity.html" > PendingTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/RawIdentifiable.html" > RawIdentifiable< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/ResourceProvider.html" > ResourceProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/SeedProvider.html" > SeedProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/SignedTransactionEntity.html" > SignedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/Synchronizer.html" > Synchronizer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/TransactionEntity.html" > TransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Protocols/ZcashRustBackendWelding.html" > ZcashRustBackendWelding< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Structs.html" > Structures< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Structs/CompactBlockProcessorNotificationKey.html" > CompactBlockProcessorNotificationKey< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/DefaultResourceProvider.html" > DefaultResourceProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/LightWalletEndpoint.html" > LightWalletEndpoint< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/WalletBirthday.html" > WalletBirthday< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/ZcashCompactBlock.html" > ZcashCompactBlock< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs.html#/s:19ZcashLightClientKit0A27RustBackendWeldingConstantsV" > ZcashRustBackendWeldingConstants< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Typealiases.html" > Type Aliases< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Typealiases.html#/s:19ZcashLightClientKit17CompactBlockRangea" > CompactBlockRange< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > Enumerations< / h1 >
< p > The following enumerations are available globally.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit26CompactBlockProcessorErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/CompactBlockProcessorError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit26CompactBlockProcessorErrorO" > CompactBlockProcessorError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Errors thrown by CompactBlock Processor< / p >
< a href = "Enums/CompactBlockProcessorError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > CompactBlockProcessorError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit16InitializerErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/InitializerError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit16InitializerErrorO" > InitializerError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Wrapper for the Rust backend. This class basically represents all the Rust-wallet
capabilities and the supporting data required to exercise those abilities.< / p >
< a href = "Enums/InitializerError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > InitializerError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21ResourceProviderErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/ResourceProviderError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21ResourceProviderErrorO" > ResourceProviderError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< a href = "Enums/ResourceProviderError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > ResourceProviderError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit16RustWeldingErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/RustWeldingError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit16RustWeldingErrorO" > RustWeldingError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< a href = "Enums/RustWeldingError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > RustWeldingError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit0B18WalletServiceErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/LightWalletServiceError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit0B18WalletServiceErrorO" > LightWalletServiceError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
2020-04-06 10:06:13 -07:00
< p > Wrapper for errors received from a Lightwalletd endpoint< / p >
2020-03-23 15:06:58 -07:00
< a href = "Enums/LightWalletServiceError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > LightWalletServiceError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< pre class = "highlight swift" > < code > < span class = "kd" > extension< / span > < span class = "kt" > LightWalletServiceError< / span > < span class = "p" > :< / span > < span class = "kt" > Equatable< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit17SynchronizerErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/SynchronizerError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit17SynchronizerErrorO" > SynchronizerError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Represents errors thrown by a Synchronizer< / p >
< a href = "Enums/SynchronizerError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > SynchronizerError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit6StatusO" > < / a >
< a name = "//apple_ref/swift/Enum/Status" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit6StatusO" > Status< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > The Status of the synchronizer< / p >
< a href = "Enums/Status.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > Status< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit15TransactionKindO" > < / a >
< a name = "//apple_ref/swift/Enum/TransactionKind" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit15TransactionKindO" > TransactionKind< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Kind of transactions handled by a Synchronizer< / p >
< a href = "Enums/TransactionKind.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > TransactionKind< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23TransactionEncoderErrorO" > < / a >
< a name = "//apple_ref/swift/Enum/TransactionEncoderError" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23TransactionEncoderErrorO" > TransactionEncoderError< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< a href = "Enums/TransactionEncoderError.html" class = "slightly-smaller" > See more< / a >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > enum< / span > < span class = "kt" > TransactionEncoderError< / span > < span class = "p" > :< / span > < span class = "kt" > Error< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< / section >
< / section >
< section id = "footer" >
2020-04-06 10:06:13 -07:00
< p > © 2020 < a class = "link" href = "https://github.com/zcash/ZcashLightClientKit" target = "_blank" rel = "external" > Francisco Gindre and Jack Grigg< / a > . All rights reserved. (Last updated: 2020-04-06)< / p >
2020-03-23 15:06:58 -07:00
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external" > jazzy ♪♫ v0.13.1< / a > , a < a class = "link" href = "https://realm.io" target = "_blank" rel = "external" > Realm< / a > project.< / p >
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >