Struct S2PMHeader 

pub struct S2PMHeader {

    pub is_s2: bool,
    pub version: u8,
    pub root_directory_offset: u64,
    pub root_directory_length: u64,
    pub metadata_offset: u64,
    pub metadata_length: u64,
    pub leaf_directory_offset: u64,
    pub leaf_directory_length: u64,
    pub data_offset: u64,
    pub data_length: u64,
    pub n_addressed_tiles: u64,
    pub n_tile_entries: u64,
    pub n_tile_contents: u64,
    pub clustered: bool,
    pub internal_compression: CompressionFormat,
    pub tile_compression: CompressionFormat,
    pub tile_type: PMTileType,
    pub min_zoom: u8,
    pub max_zoom: u8,
    pub min_longitude: f32,
    pub min_latitude: f32,
    pub max_longitude: f32,
    pub max_latitude: f32,
    pub center_zoom: u8,
    pub center_longitude: f32,
    pub center_latitude: f32,
    pub root_directory_offset1: u64,
    pub root_directory_length1: u64,
    pub root_directory_offset2: u64,
    pub root_directory_length2: u64,
    pub root_directory_offset3: u64,
    pub root_directory_length3: u64,
    pub root_directory_offset4: u64,
    pub root_directory_length4: u64,
    pub root_directory_offset5: u64,
    pub root_directory_length5: u64,
    pub leaf_directory_offset1: u64,
    pub leaf_directory_length1: u64,
    pub leaf_directory_offset2: u64,
    pub leaf_directory_length2: u64,
    pub leaf_directory_offset3: u64,
    pub leaf_directory_length3: u64,
    pub leaf_directory_offset4: u64,
    pub leaf_directory_length4: u64,
    pub leaf_directory_offset5: u64,
    pub leaf_directory_length5: u64,
}

S2PMTiles v3 header storing basic archive-level information.

Fields

is_s2: bool

True if this is an S2PMTiles v1, otherwise PMTiles v3

version: u8

versioning used for the s2-pmtiles spec

root_directory_offset: u64

the offset in the archive of the root directory for Face 0

root_directory_length: u64

the length of the root directory for Face 0

metadata_offset: u64

the offset in the archive of the JSON metadata

metadata_length: u64

the length of the JSON metadata

leaf_directory_offset: u64

the offset in the archive of the leaf directory for Face 0

leaf_directory_length: u64

the length of the leaf directory

data_offset: u64

the offset in the archive of the tile data

data_length: u64

the length of the tile data

n_addressed_tiles: u64

number of tiles addressed

n_tile_entries: u64

number of tile entries

n_tile_contents: u64

number of tile contents

clustered: bool

if the archive is clustered or not

internal_compression: CompressionFormat

if the archive is compressed or not NOTE: deprecated and only Compression::None is supported

tile_compression: CompressionFormat

what kind of compression is used for the tile data

tile_type: PMTileType

what kind of compression is used for the metadata

min_zoom: u8

the min zoom level

max_zoom: u8

the max zoom level

min_longitude: f32

the min longitude

min_latitude: f32

the min latitude

max_longitude: f32

the max longitude

max_latitude: f32

the max latitude

center_zoom: u8

the center zoom level

center_longitude: f32

the center longitude

center_latitude: f32

the center latitude

root_directory_offset1: u64

the offset in the archive of the root directory for Face 1

root_directory_length1: u64

the length of the root directory for Face 1

root_directory_offset2: u64

the offset in the archive of the root directory for Face 2

root_directory_length2: u64

the length of the root directory for Face 2

root_directory_offset3: u64

the offset in the archive of the root directory for Face 3

root_directory_length3: u64

the length of the root directory for Face 3

root_directory_offset4: u64

the offset in the archive of the root directory for Face 4

root_directory_length4: u64

the length of the root directory for Face 4

root_directory_offset5: u64

the offset in the archive of the root directory for Face 5

root_directory_length5: u64

the length of the root directory for Face 5

leaf_directory_offset1: u64

the offset in the archive of the leaf directory for Face 1

leaf_directory_length1: u64

the length of the leaf directory for Face 1

leaf_directory_offset2: u64

the offset in the archive of the leaf directory for Face 2

leaf_directory_length2: u64

the length of the leaf directory for Face 2

leaf_directory_offset3: u64

the offset in the archive of the leaf directory for Face 3

leaf_directory_length3: u64

the length of the leaf directory for Face 3

leaf_directory_offset4: u64

the offset in the archive of the leaf directory for Face 4

leaf_directory_length4: u64

the length of the leaf directory for Face 4

leaf_directory_offset5: u64

the offset in the archive of the leaf directory for Face 5

leaf_directory_length5: u64

the length of the leaf directory for Face 5

Implementations

impl S2PMHeader

pub fn from_bytes(buffer: &mut Buffer) -> Self

Convert a buffer into a S2Header

pub fn to_bytes(&self) -> Buffer

Convert a S2Header into a buffer

pub fn get_root_offset(&self, face: Face) -> u64

Get the root directory offset for a given face

pub fn get_root_length(&self, face: Face) -> u64

Get the root directory length for a given face

Trait Implementations

impl Clone for S2PMHeader

fn clone(&self) -> S2PMHeader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S2PMHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for S2PMHeader

fn default() -> S2PMHeader

Returns the “default value” for a type.

impl PartialEq for S2PMHeader

fn eq(&self, other: &S2PMHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for S2PMHeader

impl StructuralPartialEq for S2PMHeader