pmtiles 0.19.0

Implementation of the PMTiles v3 spec with multiple sync and async backends.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use std::string::FromUtf8Error;

use thiserror::Error;

use crate::Compression;

/// A specialized [`Result`] type for `PMTiles` operations.
pub type PmtResult<T> = Result<T, PmtError>;

/// Errors that can occur while reading `PMTiles` files.
#[derive(Debug, Error)]
pub enum PmtError {
    /// Invalid magic number in the `PMTiles` file header.
    #[error("Invalid magic number")]
    InvalidMagicNumber,
    /// Unsupported `PMTiles` version.
    #[error("Invalid PMTiles version")]
    UnsupportedPmTilesVersion,
    /// Invalid compression type specified.
    #[error("Invalid compression")]
    InvalidCompression,
    /// Compression type is not supported.
    #[error("Unsupported compression {0:?}")]
    UnsupportedCompression(Compression),
    /// The `PMTiles` entry is invalid.
    #[error("Invalid PMTiles entry")]
    InvalidEntry,
    /// The `PMTiles` header is invalid.
    #[error("Invalid header")]
    InvalidHeader,
    /// The `PMTiles` metadata is invalid.
    #[error("Invalid metadata")]
    InvalidMetadata,
    #[cfg(feature = "write")]
    /// Directory index entry overflow occurred during writing.
    #[error("Directory index element overflow")]
    IndexEntryOverflow,
    /// Metadata contains invalid UTF-8 encoding.
    #[error("Invalid metadata UTF-8 encoding: {0}")]
    InvalidMetadataUtf8Encoding(#[from] FromUtf8Error),
    /// The tile type is invalid.
    #[error("Invalid tile type")]
    InvalidTileType,
    /// An I/O error occurred while reading.
    #[error("IO Error {0}")]
    Reading(#[from] std::io::Error),
    #[cfg(feature = "mmap-async-tokio")]
    /// Failed to open the file for memory mapping.
    #[error("Unable to open mmap file")]
    UnableToOpenMmapFile,
    /// Unexpected number of bytes returned during reading.
    #[error("Unexpected number of bytes returned [expected: {0}, received: {1}].")]
    UnexpectedNumberOfBytesReturned(usize, usize),
    #[cfg(feature = "http-async")]
    /// The server does not support range requests.
    #[error("Range requests unsupported")]
    RangeRequestsUnsupported,
    #[cfg(any(
        feature = "http-async",
        feature = "__async-s3",
        feature = "__async-aws-s3"
    ))]
    /// The HTTP response body exceeded the requested length.
    #[error("HTTP response body is too long, Response {0}B > requested {1}B")]
    ResponseBodyTooLong(usize, usize),
    #[cfg(feature = "http-async")]
    /// An HTTP client error occurred.
    #[error(transparent)]
    Http(#[from] reqwest::Error),
    #[cfg(feature = "http-async")]
    /// Invalid header value encountered.
    #[error(transparent)]
    InvalidHeaderValue(#[from] reqwest::header::InvalidHeaderValue),
    #[cfg(feature = "__async-s3")]
    /// An S3 error occurred.
    #[error(transparent)]
    S3(#[from] s3::error::S3Error),
    #[cfg(feature = "__async-aws-s3")]
    /// An AWS S3 request error occurred.
    #[error(transparent)]
    AwsS3Request(
        #[from] Box<aws_sdk_s3::error::SdkError<aws_sdk_s3::operation::get_object::GetObjectError>>,
    ),
    #[cfg(feature = "object-store")]
    /// An object store error occurred.
    #[error(transparent)]
    ObjectStore(#[from] object_store::Error),
    /// The tile coordinate is invalid.
    #[error("Invalid coordinate {0}/{1}/{2}")]
    InvalidCoordinate(u8, u32, u32),
    /// Indicates an error occurred with the directory cache.
    #[error("An error occurred with the directory cache: {0}")]
    DirectoryCacheError(String),
}