Struct PrefixMap

pub struct PrefixMap {
    pub map: IndexMap<String, IriS>,
    /* private fields */
}

Contains declarations of prefix maps which are used in TURTLE, SPARQL and ShEx

Fields

map: IndexMap<String, IriS>

Proper prefix map associations of an alias String to an IriS

Implementations

impl PrefixMap

pub fn new() -> PrefixMap

Creates an empty (“map

pub fn with_qualify_prefix_color(self, color: Option<Color>) -> PrefixMap

Change (“color when qualifying a IRI

pub fn with_qualify_localname_color(self, color: Option<Color>) -> PrefixMap

Change color of localname when qualifying a IRI

pub fn with_qualify_semicolon_color(self, color: Option<Color>) -> PrefixMap

Change color of semicolon when qualifying a IRI

pub fn without_rich_qualifying(self) -> PrefixMap

pub fn insert(&mut self, alias: &str, iri: &IriS) -> Result<(), PrefixMapError>

Inserts an alias association to an IRI

pub fn find(&self, str: &str) -> Option<&IriS>

pub fn from_hashmap( hm: &HashMap<&str, &str>, ) -> Result<PrefixMap, PrefixMapError>

pub fn iter(&self) -> Iter<'_, String, IriS>

Return an iterator over the key-value pairs of the (“map, in their order

pub fn resolve(&self, str: &str) -> Result<IriS, PrefixMapError>

Resolves a string against a prefix map Example: Given a string like “ex:a” and a prefixmap that has alias “ex” with value “http://example.org/”, the result will be “http://example.org/a”

use std::collections::HashMap;
use prefixmap::PrefixMap;
use prefixmap::PrefixMapError;
use iri_s::*;
use std::str::FromStr;


let pm: PrefixMap = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = pm.resolve(":a")?;
let a_resolved = IriS::from_str("http://example.org/a")?;
assert_eq!(a, a_resolved);
Ok::<(), PrefixMapError>(());

let knows = pm.resolve("schema:knows")?;
let knows_resolved = IriS::from_str("http://schema.org/knows")?;
assert_eq!(knows, knows_resolved);
Ok::<(), PrefixMapError>(())

pub fn resolve_iriref(&self, iri_ref: &IriRef) -> Result<IriS, PrefixMapError>

Resolves an IriRef against a prefix map

pub fn resolve_prefix_local( &self, prefix: &str, local: &str, ) -> Result<IriS, PrefixMapError>

Resolves a prefixed alias and a local name in a prefix map to obtain the full IRI

use std::collections::HashMap;
use prefixmap::PrefixMap;


let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/"),
    ("xsd", "http://www.w3.org/2001/XMLSchema#")
]))?;

let a = pm.resolve_prefix_local("", "a")?;
let a_resolved = IriS::from_str("http://example.org/a")?;
assert_eq!(a, a_resolved);

let knows = pm.resolve_prefix_local("schema","knows")?;
let knows_resolved = IriS::from_str("http://schema.org/knows")?;
assert_eq!(knows, knows_resolved);

let xsd_string = pm.resolve_prefix_local("xsd","string")?;
let xsd_string_resolved = IriS::from_str("http://www.w3.org/2001/XMLSchema#string")?;
assert_eq!(xsd_string, xsd_string_resolved);

pub fn qualify(&self, iri: &IriS) -> String

Qualifies an IRI against a prefix map

If it can’t qualify the IRI, it returns the iri between < and >

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify(&a), ":a");

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify(&knows), "schema:knows");

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify(&other), "<http://other.org/foo>");

pub fn qualify_optional(&self, iri: &IriS) -> Option<String>

Qualifies an IRI against a prefix map

If it can’t qualify the IRI, returns None

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify(&a), Some(":a"));

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify(&knows), Some("schema:knows"));

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify(&other), None);

pub fn qualify_and_length(&self, iri: &IriS) -> (String, usize)

Qualifies an IRI against a prefix map returning the length of the qualified string

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify(&a), ":a");

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify(&knows), "schema:knows");

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify(&other), "<http://other.org/foo>");

pub fn qualify_local(&self, iri: &IriS) -> Option<String>

Qualify an IRI against a prefix map and obtains the local name

let pm = PrefixMap::from_hashmap(
  &HashMap::from([
    ("", "http://example.org/"),
    ("schema", "http://schema.org/")])
)?;
let a = IriS::from_str("http://example.org/a")?;
assert_eq!(pm.qualify_local(&a), Some("a".to_string()));

let knows = IriS::from_str("http://schema.org/knows")?;
assert_eq!(pm.qualify_local(&knows), Some("knows".to_string()));

let other = IriS::from_str("http://other.org/foo")?;
assert_eq!(pm.qualify_local(&other), None);

pub fn basic() -> PrefixMap

Basic prefixmap with common definitions

pub fn wikidata() -> PrefixMap

Default Wikidata prefixmap This source of this list is https://www.mediawiki.org/wiki/Wikibase/Indexing/RDF_Dump_Format#Full_list_of_prefixes

pub fn without_colors(self) -> PrefixMap

pub fn without_default_colors(self) -> PrefixMap

pub fn with_hyperlink(self, hyperlink: bool) -> PrefixMap

pub fn merge(&mut self, other: PrefixMap) -> Result<(), PrefixMapError>

Trait Implementations

impl Clone for PrefixMap

fn clone(&self) -> PrefixMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrefixMap

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

Formats the value using the given formatter.

impl Default for PrefixMap

fn default() -> PrefixMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrefixMap

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrefixMap

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

Formats the value using the given formatter.

impl PartialEq for PrefixMap

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

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 StructuralPartialEq for PrefixMap