Table of Contents

Class PlusCode

Namespace
Veritas.Geospatial
Assembly
Veritas.dll

Provides validation and generation for Plus Codes.

public static class PlusCode
Inheritance
PlusCode
Inherited Members

Methods

TryGenerate(Span<char>, out int)

Attempts to generate a random Plus Code into the provided buffer.

public static bool TryGenerate(Span<char> destination, out int written)

Parameters

destination Span<char>

Buffer that receives the generated Plus Code.

written int

When the method returns, contains the number of characters produced.

Returns

bool

true if generation succeeded; otherwise, false.

TryGenerate(in GenerationOptions, Span<char>, out int)

Attempts to generate a random Plus Code using the supplied options.

public static bool TryGenerate(in GenerationOptions options, Span<char> destination, out int written)

Parameters

options GenerationOptions

Options controlling generation.

destination Span<char>

Buffer that receives the generated Plus Code.

written int

When the method returns, contains the number of characters produced.

Returns

bool

true if generation succeeded; otherwise, false.

TryValidate(ReadOnlySpan<char>, out ValidationResult<PlusCodeValue>)

Attempts to validate the supplied input as a Plus Code.

public static bool TryValidate(ReadOnlySpan<char> input, out ValidationResult<PlusCodeValue> result)

Parameters

input ReadOnlySpan<char>

Candidate Plus Code to validate.

result ValidationResult<PlusCodeValue>

The validation outcome including the parsed value when valid.

Returns

bool

true if validation succeeded; otherwise, false.