Skip to main content

KnowledgeBase

Struct KnowledgeBase 

Source
pub struct KnowledgeBase { /* private fields */ }
Expand description

The knowledge base separates raw storage from the parser-facing view:

  • commands / command_idx_by_name: raw explicit command store.
  • characters / character_idx_by_name: raw character store.
  • character_command_views: zero-arg Prefix commands projected from characters, so the parser can still recognize character control sequences as commands.
  • active_command_idx_by_name: the single parser-facing index that tells lookup_command() whether the active entry for a name comes from an explicit command or a character-derived view.
  • suppressed_command_names: names removed via remove_item(Command). Prevents a deleted name from “reviving” through a character fallback.

Implementations§

Source§

impl KnowledgeBase

Source

pub fn empty() -> Self

Return the active command for name, respecting suppression.

The active entry may be an explicit command or a character-derived zero-arg view. Suppressed names always return None.

Source

pub fn build_from_packages(packages: &[&str]) -> Self

Source

pub fn try_build_from_packages( packages: &[&str], ) -> Result<Self, PackageLoadError>

Source

pub fn try_build_from_packages_for_mode( packages: &[&str], target_mode: ContentMode, ) -> Result<Self, PackageLoadError>

Source

pub fn lookup_command(&self, name: &str) -> Option<&ActiveCommandRecord>

Source

pub fn lookup_explicit_command( &self, name: &str, ) -> Option<&ActiveCommandRecord>

Look up only the explicit (non-character-derived) command for name.

Source

pub fn lookup_character(&self, name: &str) -> Option<&ActiveCharacterRecord>

Look up raw character metadata by control-sequence name.

Source

pub fn lookup_env(&self, name: &str) -> Option<&ActiveEnvironmentRecord>

Look up environment metadata by name.

Source

pub fn lookup_delimiter( &self, name: &str, is_control_sequence: bool, ) -> Option<&ActiveDelimiterRecord>

Source

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

Check whether name is registered as a delimiter control sequence.

Source

pub fn lookup_delimiter_control(&self, name: &str) -> Option<&'static str>

Look up a delimiter control, returning the interned &'static str name.

Source

pub fn insert_item( &mut self, item: impl Into<ContextItem>, ) -> Result<(), ArgSpecParseError>

Insert a context item, dispatching to the appropriate typed inserter.

Source

pub fn remove_item(&mut self, item: impl Into<ContextItem>) -> bool

Remove a previously inserted item. Returns true if found.

Source

pub fn insert_environment( &mut self, item: EnvironmentItem, ) -> Result<(), ArgSpecParseError>

Source

pub fn insert_delimiter_control(&mut self, item: DelimiterControlItem)

Trait Implementations§

Source§

impl Clone for KnowledgeBase

Source§

fn clone(&self) -> KnowledgeBase

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnowledgeBase

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,

Source§

impl<'p, T> Seq<'p, T> for T
where T: Clone,

Source§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
Source§

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.
Source§

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
Source§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
Source§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a MaybeRef.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.