HorizonOptions

public struct HorizonOptions

extension HorizonOptions: Hashable

Horizon options. For information on how to manage horizon options see HorizonEngine .registerHorizonOptions and HorizonEngine .unregisterHorizonOptions. Horizon options define the extent of the paths in the horizon and the map attributes to be collected for these paths. A set of horizon options consists of the following:

The set of horizon element types in which the client is interested,
The path search options for the main path (the path that the user is currently on, extending along the most likely trajectory),
The path search options for the sub-paths (any horizon path that is not the main path),
The maximum number of paths the client can receive.

Important

This is a Public Preview API. It may be changed or removed at any time.

Public

Defaults
Contains default values for HorizonOptions.
See more
Declaration
Swift

public enum Defaults
id
Unique ID of the HorizonOptions
Declaration
Swift

public let id: UUID
elementTypes
Types of horizon elements that are of interest.
Declaration
Swift

public let elementTypes: [HorizonElementType]
mainPathSearchOptions
Search options MainPathSearchOptions for the main path.
Declaration
Swift

public let mainPathSearchOptions: MainPathSearchOptions
subPathSearchOptions
Search options SubPathSearchOptions for sub-path levels. The container element at index i encodes search options for path level i + 1. The horizon is extended to the deepest sub-path level, as specified by the search options for sub-path levels.
Declaration
Swift

public let subPathSearchOptions: [SubPathSearchOptions]
numberOfPaths
Maximum number of paths the client can receive. The default value is 1.
Declaration
Swift

public let numberOfPaths: Int

Hashable


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: HorizonOptions, rhs: HorizonOptions) -> Bool


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)

HorizonOptions.InitializationError

InitializationError
An error that occurs during the creation of the instance.
See more
Declaration
Swift

public enum InitializationError : Error