pub struct Proto {Show 15 fields
pub name: Option<Rc<str>>,
pub code: Vec<Instr>,
pub constants: Vec<Constant>,
pub spans: Vec<Span>,
pub max_stack: u8,
pub num_params: u8,
pub is_vararg: bool,
pub protos: Vec<Rc<Proto>>,
pub upvalues: Vec<UpvalDesc>,
pub locals: Vec<LocalVar>,
pub span: Span,
pub source: Rc<SourceFile>,
pub templates: Vec<TableTemplate>,
pub cache: InlineCache,
pub verified: Verified,
}Expand description
A compiled function prototype, what the VM actually runs.
Fields§
§name: Option<Rc<str>>None for the main chunk, otherwise the declared name if there is one.
code: Vec<Instr>§constants: Vec<Constant>§spans: Vec<Span>One source span per instruction, for runtime errors.
max_stack: u8How many registers the VM needs to reserve for one call.
num_params: u8§is_vararg: bool§protos: Vec<Rc<Proto>>Prototypes of the functions defined inside this one (CLOSURE
operands).
upvalues: Vec<UpvalDesc>§locals: Vec<LocalVar>Debug info, each local’s register and live range.
span: SpanWhere the function is defined in the source.
source: Rc<SourceFile>The source every span in here points into.
templates: Vec<TableTemplate>Shapes for DUPTABLE, one per table constructor with constant keys.
cache: InlineCacheThe VM’s lookup hints (see InlineCache).
verified: VerifiedSet once verify_once has checked this tree.
Implementations§
Source§impl Proto
impl Proto
Sourcepub fn display_name(&self) -> &str
pub fn display_name(&self) -> &str
The name shown in listings and tracebacks.
Sourcepub fn disassemble(&self) -> String
pub fn disassemble(&self) -> String
A readable listing, used by rhue --dump and the snapshot tests. Nested
functions come after their parent.
Source§impl Proto
impl Proto
Sourcepub fn to_bytes(&self) -> Vec<u8> ⓘ
pub fn to_bytes(&self) -> Vec<u8> ⓘ
Saves this main chunk (and everything nested in it), without types (see
write_chunk).
Sourcepub fn from_bytes(bytes: &[u8]) -> Result<Rc<Proto>, LoadError>
pub fn from_bytes(bytes: &[u8]) -> Result<Rc<Proto>, LoadError>
Reads a chunk written by to_bytes or
write_chunk, ignoring any types. It’s not verified, run
verify before executing it.
Trait Implementations§
impl StructuralPartialEq for Proto
Auto Trait Implementations§
impl !Freeze for Proto
impl !RefUnwindSafe for Proto
impl !Send for Proto
impl !Sync for Proto
impl !UnwindSafe for Proto
impl Forget for Proto
impl Move for Proto
impl Unpin for Proto
impl UnsafeUnpin for Proto
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,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();Source§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.
Source§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);