PackedNavigationState | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

PackedNavigationState

Auxiliary object to serialize and deserialize navigation state.

Extends: Hashable
public static func == (lhs: PackedNavigationState, rhs: PackedNavigationState) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters
hasher
Hasher

The hasher to use when combining the components of this instance.

public static func of(
    trafficRoute: TrafficRoute,
    routeSearchOptions: RouteSearchOptions? = nil,
    finishPoint: RouteSearchPoint? = nil,
    routePosition: RoutePoint? = nil,
    state: State = State.disabled
) -> PackedNavigationState

Creating an object from the listed elements.

Parameters
trafficRoute
routeSearchOptions
finishPoint
routePosition
state
Returns
public static func fromBytes(
    data: Data
) throws -> PackedNavigationState

Deserialization of navigation state. Invalid elements in the stored state are skipped or replaced with default values.

Parameters
data
Returns
public static func fromModel(
    model: Model
) -> PackedNavigationState

Creating an object from the navigator model.

Parameters
model
Returns
public func toBytes() -> Data

Serialization of navigation state.

Returns
Properties
var trafficRoute
var finishPoint

The end point of the route.

var routeSearchOptions

Route building options.

var routePosition

Position on route.

var state

Current navigation state.