Struct Tile 

pub struct Tile {
    pub x: u32,
    pub y: u32,
    pub z: u8,
}

Tile X-Y-Z struct

Fields

x: u32

x value (column)

y: u32

y value (row – flipped in mbtiles)

z: u8

z value (zoom level)

Implementations

impl Tile

pub fn new(x: u32, y: u32, z: u8) -> Tile

Create a new Tile without checking validity

pub fn try_new(x: u32, y: u32, z: u8) -> Result<Tile, UtilesCoreError>

Create a Tile with validity check

Errors

Returns an error if the tile is invalid (e.g. x or y >= 2^z)

pub fn new_checked(x: u32, y: u32, z: u8) -> Option<Tile>

Construct a tile with validity check - returns Option<Tile>

pub fn new_unchecked(x: u32, y: u32, z: u8) -> Tile

Construct a tile without any checking.

pub fn flip(&self) -> Tile

flip the y value (row) and return flipped tile

pub fn bounds(&self) -> (f64, f64, f64, f64)

Return bounds tuple (west, south, east, north) for the tile

pub fn from_row_major_id(id: u64) -> Tile

Return tile from row-major tile-id

pub fn from_rmid(id: u64) -> Tile

Return tile from row-major tile-id (alias for from_row_major_id)

pub fn fmt_zxy(&self, sep: Option<&str>) -> String

Return zxy string with optional separator (default is ‘/’)

pub fn fmt_zxy_ext(&self, ext: &str, sep: Option<&str>) -> String

Return zxy string with extension and optional separator (default is ‘/’)

Examples

use utiles_core::Tile;
let tile = Tile::new(1, 2, 3);
assert_eq!(tile.fmt_zxy_ext("png", Some("-")), "3-1-2.png");
assert_eq!(tile.fmt_zxy_ext("png", None), "3/1/2.png");

pub fn from_quadkey(quadkey: &str) -> Result<Tile, UtilesCoreError>

Convert quadkey string to Tile

Errors

Returns error on invalid quadkey (e.g. “1234” – oh no ‘4’ is invalid)

pub fn from_qk(qk: &str) -> Result<Tile, UtilesCoreError>

Convert quadkey string to Tile (alias for from_quadkey)

Errors

Returns error on invalid quadkey (e.g. “1234” – oh no ‘4’ is invalid)

pub fn from_json_obj(json: &str) -> Result<Tile, UtilesCoreError>

Return tile from json-object string (e.g. {"x": 1, "y": 2, "z": 3})

Errors

Returns error if serde parsing fails

Examples

use utiles_core::Tile;
let tile = Tile::from_json_obj(r#"{"x": 1, "y": 2, "z": 3}"#).unwrap();
assert_eq!(tile, Tile::new(1, 2, 3));

pub fn from_json_arr(json: &str) -> Result<Tile, UtilesCoreError>

Return tile from json-array string (e.g. [1, 2, 3])

Errors

Returns error if serde parsing fails

Examples

use utiles_core::Tile;
let tile = Tile::from_json_arr("[1, 2, 3]").unwrap();
assert_eq!(tile, Tile::new(1, 2, 3));

pub fn from_json(json: &str) -> Result<Tile, UtilesCoreError>

Return tile from json string either object or array

Errors

Returns error if serde parsing fails

Examples

use utiles_core::Tile;
let tile_from_obj = Tile::from_json(r#"{"x": 1, "y": 2, "z": 3}"#).unwrap();
assert_eq!(tile_from_obj, Tile::new(1, 2, 3));
let tile_from_arr = Tile::from_json(r#"[1, 2, 3]"#).unwrap();
assert_eq!(tile_from_arr, Tile::new(1, 2, 3));

pub fn from_json_loose(json: &str) -> Result<Tile, UtilesCoreError>

Return tile from json string either object or array

Errors

Returns error if unable to parse json string

pub fn quadkey(&self) -> String

Return the quadkey for the tile

pub fn qk(&self) -> String

Return the quadkey for the tile (alias for quadkey)

pub fn from_lnglat_zoom( lng: f64, lat: f64, zoom: u8, truncate: Option<bool>, ) -> Result<Tile, UtilesCoreError>

Return new Tile from given (lng, lat, zoom)

Errors

Returns an error if the conversion fails resulting in invalid tile

pub fn up(&self) -> Tile

Return the bounding box of the tile

pub fn down(&self) -> Tile

Return the tile to the bottom

pub fn left(&self) -> Tile

Return the tile to the left

pub fn right(&self) -> Tile

Return the tile to the right

pub fn up_left(&self) -> Tile

Return the tile to the top left

pub fn up_right(&self) -> Tile

Return the tile to the top right

pub fn down_left(&self) -> Tile

Return the tile to the bottom left

pub fn down_right(&self) -> Tile

Return the tile to the bottom right

pub fn children1(&self) -> [Tile; 4]

Return direct children

pub fn children(&self, zoom: Option<u8>) -> Vec<Tile>

Return the children tiles of the tile

pub fn children_zorder(&self, zoom: Option<u8>) -> Vec<Tile>

Return the children tiles of the tile

pub fn parent(&self, zoom: Option<u8>) -> Option<Tile>

Return the parent tile

pub fn siblings(&self) -> Vec<Tile>

Return sibling tiles that share the same parent tile (not neighbors)

pub fn feature( &self, opts: &FeatureOptions, ) -> Result<TileFeature, UtilesCoreError>

Return a TileFeature for the tile

Errors

Returns an error if the feature creation fails (which may be impossible [2024-08-14])

impl Tile

pub fn pmtileid(&self) -> u64

Return pmtile-id for the tile

pub fn from_pmtileid(id: u64) -> Tile

Return tile from pmtile-id

pub fn from_pmid(id: u64) -> Tile

Return tile from pmtile-id (alias for from_pmtileid)

pub fn parent_pmtileid(&self) -> Option<u64>

Return the parent tile’s pmtile-id

Trait Implementations

impl Clone for Tile

fn clone(&self) -> Tile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tile

fn deserialize<__D>( __deserializer: __D, ) -> Result<Tile, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tile

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

Formats the value using the given formatter.

impl From<(u32, u32, u8)> for Tile

fn from(xyz: (u32, u32, u8)) -> Tile

Converts to this type from the input type.

impl From<(u8, u32, u32)> for Tile

fn from(xyz: (u8, u32, u32)) -> Tile

Converts to this type from the input type.

impl From<MbtTileRow> for Tile

fn from(row: MbtTileRow) -> Self

Converts to this type from the input type.

impl From<Tile> for SiblingRelationship

fn from(value: Tile) -> SiblingRelationship

Converts to this type from the input type.

impl From<Tile> for WebBBox

fn from(tile: Tile) -> WebBBox

Converts to this type from the input type.

impl From<TileCrz> for Tile

fn from(tile: TileCrz) -> Tile

Converts to this type from the input type.

impl From<TileTuple> for Tile

fn from(xyz: TileTuple) -> Tile

Converts to this type from the input type.

impl FromStr for Tile

type Err = Box<dyn Error>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Tile, <Tile as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Tile

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IsOk for Tile

fn ok(&self) -> Result<Tile, UtilesCoreError>

Returns Ok if the value is Ok or an error

impl Ord for Tile

fn cmp(&self, other: &Tile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Tile

fn eq(&self, other: &Tile) -> 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 PartialOrd for Tile

fn partial_cmp(&self, other: &Tile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Tile) -> bool

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Tile

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TileChildren1 for Tile

fn children1(&self) -> [Tile; 4]

Returns direct children in Z order: 1) top-left 2) top-right 3) bottom-left 4) bottom-right

impl TileLike for &Tile

fn x(&self) -> u32

x coordinate (column)

fn y(&self) -> u32

y coordinate (row – flipped for TMS)

fn z(&self) -> u8

z coordinate (zoom level)

fn zoom(&self) -> u8

zoom level

fn yflip(&self) -> u32

x coordinate

fn flipy(&self) -> u32

both bc I keep forgetting which is which

fn yup(&self) -> u32

fn xyz_str_fslash(&self) -> String

fn zxy_str_fslash(&self) -> String

fn xyz_str_sep(&self, sep: &str) -> String

fn zxy_str_sep(&self, sep: &str) -> String

fn tile(&self) -> Tile

Return Tile struct

fn valid(&self) -> bool

Return if the tile is valid (x, y is in bounds for zoom level z)

fn ul(&self) -> LngLat

Return the ul (upper left) corner of the tile

fn ur(&self) -> LngLat

Return the ur (upper right) corner of the tile

fn lr(&self) -> LngLat

Return the lr (lower right) corner of the tile

fn ll(&self) -> LngLat

Return the ll (lower left) corner of the tile

fn quadkey(&self) -> String

Return the quadkey for the tile

fn qk(&self) -> String

Return the quadkey for the tile (alias for quadkey)

fn pmtileid(&self) -> u64

Return the pmtile-id for the tile

fn pmid(&self) -> u64

Return the pmtile id

fn row_major_id(&self) -> u64

Return the row major id for the tile

fn rmid(&self) -> u64

Return the row major id for the tile (alias for row_major_id)

fn bbox(&self) -> (f64, f64, f64, f64)

Return the geo-bbox tuple for the tile (west, south, east, north)

fn geobbox(&self) -> BBox

fn webbbox(&self) -> WebBBox

fn bbox_string(&self) -> String

fn center(&self) -> LngLat

Return the center of the tile as a LngLat

fn json_arr(&self) -> String

Return json array string for tile with spaces after commas

fn json_arr_min(&self) -> String

Return json array string for tile with no spaces after commas

fn json_obj(&self) -> String

Return json object string for tile

fn json(&self) -> String

Return json object string for tile

fn tuple_string(&self) -> String

Return tuple string for tile (x, y, z)

fn mbtiles_sql_where(&self) -> String

Return sql WHERE clause for querying mbtiles (y is up)

fn zbox(&self) -> TileZBox

return zbox for tile-like

fn children_zbox(&self, depth: Option<u8>) -> TileZBox

Return children-zbox for tile-like at optional depth (default 1)

fn neighbors(&self, wrapx: bool) -> Vec<Tile>

Return neighbor tiles for tile-like optionally wrapping x

impl TileLike for Tile

fn x(&self) -> u32

x coordinate (column)

fn y(&self) -> u32

y coordinate (row – flipped for TMS)

fn z(&self) -> u8

z coordinate (zoom level)

fn zoom(&self) -> u8

zoom level

fn yflip(&self) -> u32

x coordinate

fn flipy(&self) -> u32

both bc I keep forgetting which is which

fn yup(&self) -> u32

fn xyz_str_fslash(&self) -> String

fn zxy_str_fslash(&self) -> String

fn xyz_str_sep(&self, sep: &str) -> String

fn zxy_str_sep(&self, sep: &str) -> String

fn tile(&self) -> Tile

Return Tile struct

fn valid(&self) -> bool

Return if the tile is valid (x, y is in bounds for zoom level z)

fn ul(&self) -> LngLat

Return the ul (upper left) corner of the tile

fn ur(&self) -> LngLat

Return the ur (upper right) corner of the tile

fn lr(&self) -> LngLat

Return the lr (lower right) corner of the tile

fn ll(&self) -> LngLat

Return the ll (lower left) corner of the tile

fn quadkey(&self) -> String

Return the quadkey for the tile

fn qk(&self) -> String

Return the quadkey for the tile (alias for quadkey)

fn pmtileid(&self) -> u64

Return the pmtile-id for the tile

fn pmid(&self) -> u64

Return the pmtile id

fn row_major_id(&self) -> u64

Return the row major id for the tile

fn rmid(&self) -> u64

Return the row major id for the tile (alias for row_major_id)

fn bbox(&self) -> (f64, f64, f64, f64)

Return the geo-bbox tuple for the tile (west, south, east, north)

fn geobbox(&self) -> BBox

fn webbbox(&self) -> WebBBox

fn bbox_string(&self) -> String

fn center(&self) -> LngLat

Return the center of the tile as a LngLat

fn json_arr(&self) -> String

Return json array string for tile with spaces after commas

fn json_arr_min(&self) -> String

Return json array string for tile with no spaces after commas

fn json_obj(&self) -> String

Return json object string for tile

fn json(&self) -> String

Return json object string for tile

fn tuple_string(&self) -> String

Return tuple string for tile (x, y, z)

fn mbtiles_sql_where(&self) -> String

Return sql WHERE clause for querying mbtiles (y is up)

fn zbox(&self) -> TileZBox

return zbox for tile-like

fn children_zbox(&self, depth: Option<u8>) -> TileZBox

Return children-zbox for tile-like at optional depth (default 1)

fn neighbors(&self, wrapx: bool) -> Vec<Tile>

Return neighbor tiles for tile-like optionally wrapping x

impl TileParent for Tile

fn parent(&self, zoom: Option<u8>) -> Option<Tile>

fn root() -> Tile

fn iter_parents(&self) -> Parents<Self>

impl TryFrom<&Map<String, Value>> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from( map: &Map<String, Value>, ) -> Result<Tile, <Tile as TryFrom<&Map<String, Value>>>::Error>

Performs the conversion.

impl TryFrom<&Value> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from(val: &Value) -> Result<Tile, <Tile as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Vec<Value>> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from( arr: &Vec<Value>, ) -> Result<Tile, <Tile as TryFrom<&Vec<Value>>>::Error>

Performs the conversion.

impl TryFrom<&str> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Tile, <Tile as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<(u32, u32, u32)> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from( xyz: (u32, u32, u32), ) -> Result<Tile, <Tile as TryFrom<(u32, u32, u32)>>::Error>

Performs the conversion.

impl TryFrom<(u64, u64, u64)> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from( tuple: (u64, u64, u64), ) -> Result<Tile, <Tile as TryFrom<(u64, u64, u64)>>::Error>

Performs the conversion.

impl TryFrom<Value> for Tile

type Error = UtilesCoreError

The type returned in the event of a conversion error.

fn try_from(val: Value) -> Result<Tile, <Tile as TryFrom<Value>>::Error>

Performs the conversion.

impl Copy for Tile

impl Eq for Tile

impl StructuralPartialEq for Tile