Struct Tags

pub struct Tags { /* private fields */ }

A map from string keys to string values. This makes copies of strings for convenience; don’t use in performance sensitive contexts.

Implementations

impl Tags

pub fn from_pairs<I, K, V>(tags: I) -> Result<Self, DuplicateKeyError>

where I: IntoIterator<Item = (K, V)>, K: Into<TagKey>, V: Into<TagVal>,

Construct from iterator of pairs

Errors

If a duplicate key is provided.

pub fn from_pair<K, V>(key: K, val: V) -> Self

where K: Into<TagKey>, V: Into<TagVal>,

Construct from pair

pub fn is_empty(&self) -> bool

Expose data as vector of pairs

pub fn to_str_pairs(&self) -> Vec<(&str, &str)>

Expose data as vector of pairs

pub fn to_vec(&self) -> Vec<String>

Vector of = separated strings

pub fn get<Q>(&self, q: &Q) -> Option<&str>

where TagKey: Borrow<Q>, Q: Ord + Hash + Eq + ?Sized,

Get value from tags given a key

pub fn is<Q>(&self, q: &Q, v: &str) -> bool

where TagKey: Borrow<Q>, Q: Ord + Hash + Eq + ?Sized,

Return if tags key has value, return false if key does not exist.

pub fn is_any<Q>(&self, q: &Q, values: &[&str]) -> bool

where TagKey: Borrow<Q>, Q: Ord + Hash + Eq + ?Sized,

Return if tags key has any of the values, return false if the key does not exist.

pub fn subset<'any, I, Q, O>(&self, keys: I) -> Self

where I: IntoIterator<Item = &'any Q>, TagKey: Borrow<Q>, Q: 'any + Ord + Hash + Eq + ?Sized + ToOwned<Owned = O>, O: Into<TagKey>,

Get a subset of the tags

pub fn pairs_with_stem<Q>(&self, q: &Q) -> Vec<(&str, &str)>

where Q: AsRef<str> + ?Sized,

Get node given a key part

pub fn checked_insert<K: Into<TagKey>, V: Into<TagVal>>( &mut self, key: K, val: V, ) -> Result<(), DuplicateKeyError>

Errors

If duplicate key is inserted.

Trait Implementations

impl Clone for Tags

fn clone(&self) -> Tags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tags

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

Formats the value using the given formatter.

impl Default for Tags

fn default() -> Tags

Returns the “default value” for a type.

impl FromStr for Tags

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse ‘=’ separated tag pairs from a newline separated list.

use std::str::FromStr;
use osm_tags::Tags;
let tags = Tags::from_str("foo=bar\nabra=cadabra").unwrap();
assert_eq!(tags.get("foo"), Some("bar"));

type Err = ParseTagsError

The associated error which can be returned from parsing.

impl ToString for Tags

fn to_string(&self) -> String

Return tags as an ‘=’ separated list

use std::str::FromStr;
use std::string::ToString;
use osm_tags::Tags;
let tags = Tags::from_str("foo=bar\nabra=cadabra").unwrap();
assert_eq!(tags.to_string(), "abra=cadabra\nfoo=bar");