pub struct FileNamespaces { /* private fields */ }Expand description
The scope of every file in the program, keyed by its index in sources.
A name written in a file resolves in that file’s scope, whether it is
written in a signature or in a function body: the file’s own declarations,
the symbols its bare imports merged in, and the modules it bound with as.
A module imported under an alias therefore still sees its own declarations
while its bodies compile, which the file that imported it does not.
File 0 is the entry file. Its scope is the program’s outward surface: what an embedding host can call and what the artifact exporter writes entry points for.
Implementations§
Source§impl FileNamespaces
impl FileNamespaces
pub fn insert(&mut self, file_idx: u16, namespace: Namespace)
pub fn get(&self, file_idx: u16) -> &Namespace
pub fn get_mut(&mut self, file_idx: u16) -> &mut Namespace
Sourcepub fn checkpoint(&self) -> FileNamespacesCheckpoint
pub fn checkpoint(&self) -> FileNamespacesCheckpoint
The symbol count of every file’s scope, so a compile attempt that
declares into one can be undone with FileNamespaces::rollback_to.
Every file is captured, not only the entry one: a compile writes into
the scope of the file the body it is compiling was written in. A
parameter inferred to be a function is declared in the scope the callee
was written in, and a let bound to a function in the scope of the
file the let sits in, so a call that reaches into an imported module
grows that module’s scope. Both declarations remove themselves once the
body they belong to is compiled, which is why only an attempt that
aborts partway leaves one behind.
A namespace’s children are not captured: one is pushed only where an import is parsed, and that happens before any of this state can be rolled back.
Sourcepub fn rollback_to(&mut self, checkpoint: &FileNamespacesCheckpoint)
pub fn rollback_to(&mut self, checkpoint: &FileNamespacesCheckpoint)
Truncates every file’s scope back to checkpoint.
A file the checkpoint does not name had no symbols of its own to keep: a lookup against a file index nothing was parsed for creates its entry, empty, on demand.
Trait Implementations§
Source§impl Clone for FileNamespaces
impl Clone for FileNamespaces
Source§fn clone(&self) -> FileNamespaces
fn clone(&self) -> FileNamespaces
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for FileNamespaces
impl Debug for FileNamespaces
Source§impl Default for FileNamespaces
impl Default for FileNamespaces
Source§fn default() -> FileNamespaces
fn default() -> FileNamespaces
Auto Trait Implementations§
impl !Send for FileNamespaces
impl !Sync for FileNamespaces
impl Freeze for FileNamespaces
impl RefUnwindSafe for FileNamespaces
impl Unpin for FileNamespaces
impl UnsafeUnpin for FileNamespaces
impl UnwindSafe for FileNamespaces
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);