Struct QueryAliases 

pub struct QueryAliases { /* private fields */ }

An ordered set of named query definitions.

Examples

use molframe_query::{Query, QueryAliases};

let compile = |source| match Query::compile(source) {
    Ok(query) => query,
    Err(findings) => panic!("{findings:?}"),
};
let mut aliases = QueryAliases::new();
assert!(aliases.define("heme", compile("resname HEM")).is_ok());
let pocket = compile("byres (within 5 of $heme) and protein");
let Ok(closed) = aliases.resolve(&pocket) else {
    panic!("every name is defined");
};
assert!(closed.references().is_empty());
assert_eq!(
    closed.fingerprint(),
    compile("byres (within 5 of (resname HEM)) and protein").fingerprint(),
);

Implementations

impl QueryAliases

pub const MAX_DEPTH: usize = 64

The deepest chain of references resolution follows before refusing.

Interactive definitions nest a handful of levels deep; the bound exists so that a pathological or adversarial chain cannot exhaust the stack.

pub fn new() -> Self

An empty set of definitions.

pub fn is_valid_name(name: &str) -> bool

Whether name is spelled as a definable name.

A name starts with an ASCII letter or underscore and continues with ASCII letters, digits and underscores, which is exactly what may follow $ in a query.

pub fn define( &mut self, name: impl Into<Box<str>>, query: Query, ) -> Result<Option<Query>, Diagnostic>

Defines or redefines name, returning the definition it replaced.

The definition is stored as written: its own references are resolved when a query that uses it is resolved, so redefining a name it depends on changes what it means.

Errors

Returns a syntax diagnostic when name is not a valid name.

pub fn remove(&mut self, name: &str) -> Option<Query>

Removes name, returning its definition.

pub fn get(&self, name: &str) -> Option<&Query>

The definition of name, as written.

pub fn contains(&self, name: &str) -> bool

Whether name is defined.

pub fn names(&self) -> impl Iterator<Item = &str>

Defined names in ascending order.

pub fn len(&self) -> usize

Number of definitions.

pub fn is_empty(&self) -> bool

Whether nothing is defined.

pub fn resolve(&self, query: &Query) -> Result<Query, Vec<Diagnostic>>

Replaces every named reference in query with its definition.

The result mentions no name, so it can be evaluated, fingerprinted or sent elsewhere without these definitions. A query with no references is returned unchanged, source text included.

Errors

Returns E4005 for a name with no definition, E4006 for definitions that refer to each other in a cycle, and E4007 when references nest deeper than Self::MAX_DEPTH.

Trait Implementations

impl Clone for QueryAliases

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryAliases

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

Formats the value using the given formatter.

impl Default for QueryAliases

fn default() -> Self

Returns the “default value” for a type.