Struct tilejson::VectorLayer

pub struct VectorLayer {
    pub id: String,
    pub fields: BTreeMap<String, String>,
    pub description: Option<String>,
    pub maxzoom: Option<u8>,
    pub minzoom: Option<u8>,
    pub other: BTreeMap<String, Value>,
}

Each object describes one layer of vector tile data.

A vector_layer object MUST contain the id and fields keys, and MAY contain the description, minzoom, or maxzoom keys. An implementation MAY include arbitrary keys in the object outside of those defined in this specification.

Note: When describing a set of raster tiles or other tile format that does not have a “layers” concept (i.e. “format”: “jpeg”), the vector_layers key is not required.

These keys are used to describe the situation where different sets of vector layers appear in different zoom levels of the same set of tiles, for example in a case where a “minor roads” layer is only present at high zoom levels.

{
  "vector_layers": [
    {
      "id": "roads",
      "description": "Roads and their attributes",
      "minzoom": 2,
      "maxzoom": 16,
      "fields": {
        "type": "One of: trunk, primary, secondary",
        "lanes": "Number",
        "name": "String",
        "sidewalks": "Boolean"
      }
    },
    {
      "id": "countries",
      "description": "Admin 0 (country) boundaries",
      "minzoom": 0,
      "maxzoom": 16,
      "fields": {
        "iso": "ISO 3166-1 Alpha-2 code",
        "name": "English name of the country",
        "name_ar": "Arabic name of the country"
      }
    },
    {
      "id": "buildings",
      "description": "A layer with an empty fields object",
      "fields": {}
    }
  ]
}

See https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#33-vector_layers

Fields

id: String

A string value representing the the layer id.

For added context, this is referred to as the name of the layer in the Mapbox Vector Tile spec. See https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#331-id

fields: BTreeMap<String, String>

An object whose keys and values are the names and descriptions of attributes available in this layer.

Each value (description) MUST be a string that describes the underlying data. If no fields are present, the fields key MUST be an empty object. https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#332-fields

description: Option<String>

A string representing a human-readable description of the entire layer’s contents.

See https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#333-description

maxzoom: Option<u8>

An integer representing the highest zoom level whose tiles this layer appears in.

maxzoom MUST be less than or equal to the set of tiles’ maxzoom. See https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#334-minzoom-and-maxzoom

minzoom: Option<u8>

An integer representing the lowest zoom level whose tiles this layer appears in.

minzoom MUST be greater than or equal to the set of tiles’ minzoom. See https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#334-minzoom-and-maxzoom

other: BTreeMap<String, Value>

Any unrecognized fields will be stored here.

Implementations

impl VectorLayer

pub fn new(id: String, fields: BTreeMap<String, String>) -> Self

Trait Implementations

impl Clone for VectorLayer

fn clone(&self) -> VectorLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VectorLayer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorLayer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorLayer

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for VectorLayer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VectorLayer

impl StructuralEq for VectorLayer

impl StructuralPartialEq for VectorLayer