Struct TextIndexScope 

pub struct TextIndexScope {
    pub graphs: TextIndexGraphs,
    pub predicates: TextIndexPredicates,
}

What a text index covers: a graph scope and a predicate filter. The Default is the pre-0.4.0 index — the default graph, every predicate — and it is the one scope that writes no scope block.

Fields

graphs: TextIndexGraphs

The graphs whose literals are indexed.

predicates: TextIndexPredicates

The predicates whose literals are indexed.

Implementations

impl TextIndexScope

pub fn from_options<I, E>( graphs: TextIndexGraphs, include: I, exclude: E, ) -> Result<TextIndexScope, String>

where I: IntoIterator, <I as IntoIterator>::Item: AsRef<str>, E: IntoIterator, <E as IntoIterator>::Item: AsRef<str>,

Build a scope from the CLI’s spelling: a graph scope and predicate IRIs to include or to exclude (bare or <…>). Giving both lists is an error — an include list already says exactly what is indexed. Empty lists mean every predicate.

pub fn is_default(&self) -> bool

The pre-0.4.0 scope (default graph, every predicate) — written with no scope block.

pub fn restricts_predicates(&self) -> bool

Does the scope leave some predicate’s literals out? Such an index is written under crate::header::SectionKind::TextIndexPartial so that readers which do not know scopes never prune a filter with it.

pub fn covers_named_graphs(&self) -> bool

Are the named graphs’ literals indexed too?

pub fn covers_predicate(&self, p: &str) -> bool

Are literals of predicate p (an N-Triples token <…>) indexed?

pub fn covers_pattern_predicate(&self, p: Option<&str>) -> bool

Does the index cover a triple pattern’s literals? p is the pattern’s constant predicate, or None for a variable one — which can bind any predicate, so only an every-predicate index covers it.

pub fn listed_predicates(&self) -> &[String]

The predicate list of an include/exclude scope (empty for every-predicate).

pub fn describe(&self) -> String

One line for logs and rete info: what the index covers.

Trait Implementations

impl Clone for TextIndexScope

fn clone(&self) -> TextIndexScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextIndexScope

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

Formats the value using the given formatter.

impl Default for TextIndexScope

fn default() -> TextIndexScope

Returns the “default value” for a type.

impl Eq for TextIndexScope

impl Hash for TextIndexScope

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 IntoTextIndex for TextIndexScope

fn into_text_index(self) -> Option<TextIndexScope>

None = build no text index.

impl PartialEq for TextIndexScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextIndexScope