#[repr(C)]pub struct NativeCtx {Show 17 fields
pub regs: *mut Data,
pub objs: *const u8,
pub status: u32,
pub err_at: u32,
pub err_a: i64,
pub err_b: i64,
pub marking: u64,
pub ret: [u64; 2],
pub ceiling: i64,
pub segment_base: i64,
pub dylibs: *const *const u8,
pub machine: *mut c_void,
pub shade: extern "C" fn(*mut Self, u64, u64),
pub print: extern "C" fn(*mut Self, u64, u64),
pub call_vm: extern "C" fn(*mut Self, u64, u64, u64, i64, *const u64, u64) -> u32,
pub push_roots: extern "C" fn(*mut Self, *const u64, u64),
pub pop_roots: extern "C" fn(*mut Self, u64),
}Expand description
What a native function and the VM share while it runs. One lives for each run of the interpreter, and every call into native code during that run reuses it.
Fields§
§regs: *mut DataThe register file.
objs: *const u8The object pool’s first entry. The pool can move when it grows, so the VM refreshes this whenever control comes back from it.
status: u32Why the code stopped, one of the abi::STATUS_* codes.
err_at: u32The instruction a failure happened at.
err_a: i64§err_b: i64§marking: u64Whether the collector is marking, when a store has to shade what it overwrites.
ret: [u64; 2]The two words of the value an entry point returns.
ceiling: i64The call depth native code may recurse to before a call carries on in the interpreter; each native function is handed how far below it it stands.
segment_base: i64The call depth below the first function of the native code running.
dylibs: *const *const u8The resolved address of each dylib function, in binding order.
machine: *mut c_voidThe interpreter the helpers work on.
shade: extern "C" fn(*mut Self, u64, u64)Shades a value a store overwrites while the collector marks.
print: extern "C" fn(*mut Self, u64, u64)Prints a value.
call_vm: extern "C" fn(*mut Self, u64, u64, u64, i64, *const u64, u64) -> u32Runs a function on the interpreter: its first instruction, the register its result lands in, the call instruction, how far below the ceiling the caller stands, and the values to keep alive meanwhile.
push_roots: extern "C" fn(*mut Self, *const u64, u64)Keeps values the code holds alive across a call that can collect.
pop_roots: extern "C" fn(*mut Self, u64)Lets go of values Self::push_roots kept.
Auto Trait Implementations§
impl !Send for NativeCtx
impl !Sync for NativeCtx
impl Freeze for NativeCtx
impl RefUnwindSafe for NativeCtx
impl Unpin for NativeCtx
impl UnsafeUnpin for NativeCtx
impl UnwindSafe for NativeCtx
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
§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);