Trait Glossary

pub trait Glossary: Debug {
    // Required method
    fn look_up(&self, name: &str) -> Option<Rc<Alias>>;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

Interface used by the parser to look up aliases

This trait is an abstract interface that represents an immutable collection of aliases. The parser uses this trait to look up aliases when it encounters a command word in a simple command.

Required Methods

fn look_up(&self, name: &str) -> Option<Rc<Alias>>

Looks up an alias by name.

If an alias with the given name is found, it is returned. Otherwise, the return value is None.

Provided Methods

fn is_empty(&self) -> bool

Returns whether the glossary is empty.

If the glossary is empty, the parser can skip alias expansion. This method is used as a hint to optimize alias expansion.

If the glossary has any aliases, it must return false.

The default implementation returns false.

Implementations on Foreign Types

impl<T: Glossary> Glossary for &T

fn look_up(&self, name: &str) -> Option<Rc<Alias>>

fn is_empty(&self) -> bool

impl<T: Glossary> Glossary for &mut T

fn look_up(&self, name: &str) -> Option<Rc<Alias>>

fn is_empty(&self) -> bool

impl<T: Glossary> Glossary for RefCell<T>

Allows a glossary to be wrapped in a RefCell.

This implementation’s methods immutably borrow the inner glossary. If the inner glossary is mutably borrowed at the same time, it panics.

fn look_up(&self, name: &str) -> Option<Rc<Alias>>

fn is_empty(&self) -> bool

Implementors

impl Glossary for EmptyGlossary

impl Glossary for AliasSet