AvoidOptions

public struct AvoidOptions

Specifies avoidance criteria.

Important

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

Lifecycle

  • Declaration

    Swift

    public init
    (
        avoids: Set<AvoidType>? = nil,
        vignette: Vignette? = nil,
        avoidAreas: Set<BoundingBox>? = nil
    )

    Parameters

    avoids

    A set of road types and travel modes to avoid.
    vignette

    Either .avoidVignette or .allowVignette to specify in which countries toll roads that require vignettes may be taken.
    avoidAreas

    A set of bounding boxes to avoid.

Public

  • A set of road types and travel modes to avoid.

    Declaration

    Swift

    public let avoids: Set<AvoidType>?

  • Either .avoidVignette or .allowVignette to specify in which countries toll roads that require vignettes may be taken.

    Declaration

    Swift

    public let vignette: Vignette?

  • A set of bounding boxes to avoid.

    Declaration

    Swift

    public let avoidAreas: Set<BoundingBox>?

AvoidOptions

  • Copies the current AvoidOptions with changes specified in build closure

    Declaration

    Swift

    public func copy(build: (inout Builder) -> ()) -> AvoidOptions

    Parameters

    build

    This closure allows for change of AvoidOptions values

    Return Value

    AvoidOptions with the changes set on the closure

  • The Builder creates a new instance of AvoidOptions with modified fields.

    Declaration

    Swift

    public struct Builder