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

Methods for PrefixMap manipulation

pub fn new() -> PrefixMap

Creates an empty map

pub fn len(&self) -> usize

Returns the number of prefix associations in the PrefixMap

pub fn is_empty(&self) -> bool

Returns true if the PrefixMap is empty

pub fn add_prefix<A, I>( &mut self, alias: A, iri: I, ) -> Result<(), PrefixMapError>

where A: AsRef<str>, I: Into<IriS>,

Inserts an alias association to an IRI

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

Finds an IRI associated with a given alias

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

Creates a PrefixMap from a HashMap

Returns an error if any of the IRIs in the HashMap are invalid.

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

Merges another PrefixMap into this one.

Returns an error if any of the aliases in the other PrefixMap already exist in this one.

pub fn aliases(&self) -> impl Iterator<Item = &String>

Returns an iterator over the aliases in the PrefixMap

impl PrefixMap

Formatting for PrefixMap outputs

pub fn without_colors(self) -> Self

Disable all colors when qualifying IRIs

pub fn without_default_colors(self) -> Self

Use default colors when qualifying IRIs

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

Enable or disable hyperlinking when qualifying IRIs

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

Change color when qualifying a IRI

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

Change color of localname when qualifying a IRI

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

Change color of semicolon when qualifying a IRI

pub fn without_rich_qualifying(self) -> Self

Disable all rich qualifying (colors and hyperlinks)

impl PrefixMap

Common predefined prefix maps

pub fn basic() -> PrefixMap

Basic prefixmap with common definitions. This includes:

• default
• dc
• rdf
• rdfs
• sh
• xsd

pub fn wikidata() -> PrefixMap

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

impl PrefixMap

Qualifying IRIs against a PrefixMap

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

Qualifies an IRI against a PrefixMap

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

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

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

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

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

Qualifies an IRI against a PrefixMap

If it can’t qualify the IRI, returns None

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

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

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

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

Qualifies an IRI against a PrefixMap, returning the length of the qualified string

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

let knows = IriS::from_str("https://schema.org/knows")?;
assert_eq!(pm.qualify_and_length(&knows), ("schema:knows".to_string(),12));

let other = IriS::from_str("https://other.org/foo")?;
assert_eq!(pm.qualify_and_length(&other), ("<https://other.org/foo>".to_string(), 23));

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

Qualify an IRI against a PrefixMap and obtains the local name.

Returns None if it can’t qualify the IRI.

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

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

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

impl PrefixMap

Resolving strings and IRI references against a PrefixMap

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

Resolves a string against a prefix map

Returns an error if the prefix is not found in the prefix map or if the string is not a valid IRI.

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

let pm: PrefixMap = PrefixMap::from_hashmap(
  HashMap::from([
    ("", "https://example.org/"),
    ("schema", "https://schema.org/")])
)?;

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

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

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

Resolves an IriRef against a PrefixMap

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

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

Returns an error if:

• the prefix is not found in the prefix map.
• the resulting IRI is invalid.

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

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

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

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

Trait Implementations

impl Clone for PrefixMap

fn clone(&self) -> PrefixMap

Returns a duplicate 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

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<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrefixMap

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

Formats the value using the given formatter.

impl Iterator for PrefixMap

type Item = (String, IriS)

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>

where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self>

where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType

where Self: Sized, Self::Item: Try, <Self::Item as Try>::Residual: Residual<B>, B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect)

Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max(self) -> Option<Self::Item>

where Self: Sized, Self::Item: Ord,

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item>

where Self: Sized, Self::Item: Ord,

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: Copy + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: Clone + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn cycle(self) -> Cycle<Self>

where Self: Sized + Clone,

Repeats an iterator endlessly.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering

where I: IntoIterator<Item = Self::Item>, Self::Item: Ord, Self: Sized,

Lexicographically compares the elements of this Iterator with those of another.

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

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

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted(self) -> bool

where Self: Sized, Self::Item: PartialOrd,

Checks if the elements of this iterator are sorted.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PrefixMap

impl StructuralPartialEq for PrefixMap