Struct OfflineRegionStatus

Namespace

Maplibre.NativeFfi

Assembly

Maplibre.NativeFfi.dll

The download progress of an offline region.

public readonly record struct OfflineRegionStatus : IEquatable<OfflineRegionStatus>

Implements

IEquatable<OfflineRegionStatus>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

See mln_offline_region_status in the C API reference.

Constructors

OfflineRegionStatus(OfflineRegionDownloadState, ulong, ulong, ulong, ulong, ulong, ulong, bool, bool)

The download progress of an offline region.

public OfflineRegionStatus(OfflineRegionDownloadState DownloadState, ulong CompletedResourceCount, ulong CompletedResourceSize, ulong CompletedTileCount, ulong RequiredTileCount, ulong CompletedTileSize, ulong RequiredResourceCount, bool RequiredResourceCountIsPrecise, bool Complete)

Parameters

DownloadState OfflineRegionDownloadState

CompletedResourceCount ulong

The resources downloaded so far, tiles included.

CompletedResourceSize ulong

The size of the downloaded resources in bytes, tiles included.

CompletedTileCount ulong

RequiredTileCount ulong

CompletedTileSize ulong

The size of the downloaded tiles in bytes.

RequiredResourceCount ulong

The resources that the region needs, tiles included. Until required_resource_count_is_precise is true, this is only a lower bound.

RequiredResourceCountIsPrecise bool

Complete bool

Whether the region has downloaded every resource it needs.

Remarks

See mln_offline_region_status in the C API reference.

Properties

Complete

Whether the region has downloaded every resource it needs.

public bool Complete { get; init; }

Property Value

bool

CompletedResourceCount

The resources downloaded so far, tiles included.

public ulong CompletedResourceCount { get; init; }

Property Value

ulong

CompletedResourceSize

The size of the downloaded resources in bytes, tiles included.

public ulong CompletedResourceSize { get; init; }

Property Value

ulong

CompletedTileCount

public ulong CompletedTileCount { get; init; }

Property Value

ulong

CompletedTileSize

The size of the downloaded tiles in bytes.

public ulong CompletedTileSize { get; init; }

Property Value

ulong

DownloadState

public OfflineRegionDownloadState DownloadState { get; init; }

Property Value

OfflineRegionDownloadState

RequiredResourceCount

The resources that the region needs, tiles included. Until required_resource_count_is_precise is true, this is only a lower bound.

public ulong RequiredResourceCount { get; init; }

Property Value

ulong

RequiredResourceCountIsPrecise

public bool RequiredResourceCountIsPrecise { get; init; }

Property Value

bool

RequiredTileCount

public ulong RequiredTileCount { get; init; }

Property Value

ulong