pub struct BootloaderDebugTracer {
pub result: Arc<RwLock<Result<BootloaderDebug, String>>>,
}
Expand description
The role of this tracer is to read the memory slots directly from bootloader memory at the end of VM execution - and put them into BootloaderDebug object.
Fields§
§result: Arc<RwLock<Result<BootloaderDebug, String>>>
Implementations§
Trait Implementations§
Source§impl Clone for BootloaderDebugTracer
impl Clone for BootloaderDebugTracer
Source§fn clone(&self) -> BootloaderDebugTracer
fn clone(&self) -> BootloaderDebugTracer
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BootloaderDebugTracer
impl Debug for BootloaderDebugTracer
Source§impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> DynTracer<S, SimpleMemory<H>> for BootloaderDebugTracer
fn before_decoding(&mut self, _state: VmLocalStateData<'_>, _memory: &M)
fn after_decoding( &mut self, _state: VmLocalStateData<'_>, _data: AfterDecodingData, _memory: &M, )
fn before_execution( &mut self, _state: VmLocalStateData<'_>, _data: BeforeExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
fn after_execution( &mut self, _state: VmLocalStateData<'_>, _data: AfterExecutionData, _memory: &M, _storage: Rc<RefCell<S>>, )
Source§impl<H: HistoryMode> ExecutionEndTracer<H> for BootloaderDebugTracer
impl<H: HistoryMode> ExecutionEndTracer<H> for BootloaderDebugTracer
fn should_stop_execution(&self) -> bool
Source§impl<S: WriteStorage, H: HistoryMode> ExecutionProcessing<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> ExecutionProcessing<S, H> for BootloaderDebugTracer
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, )
fn before_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, )
fn after_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, )
fn after_vm_execution( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
Source§impl IntoOldVmTracer for BootloaderDebugTracer
impl IntoOldVmTracer for BootloaderDebugTracer
fn old_tracer(&self) -> OldTracers
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
Source§fn after_vm_execution(
&mut self,
state: &mut ZkSyncVmState<S, H>,
_bootloader_state: &BootloaderState,
_stop_reason: VmExecutionStopReason,
)
fn after_vm_execution( &mut self, state: &mut ZkSyncVmState<S, H>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
§fn initialize_tracer(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
)
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, )
§fn finish_cycle(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
_bootloader_state: &mut BootloaderState,
) -> TracerExecutionStatus
fn finish_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, ) -> TracerExecutionStatus
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
Source§fn after_vm_execution(
&mut self,
_state: &mut ZkSyncVmState<S, H>,
_bootloader_state: &BootloaderState,
_stop_reason: VmExecutionStopReason,
)
fn after_vm_execution( &mut self, _state: &mut ZkSyncVmState<S, H>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
§fn initialize_tracer(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
)
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, )
§fn finish_cycle(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
_bootloader_state: &mut BootloaderState,
) -> TracerExecutionStatus
fn finish_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, ) -> TracerExecutionStatus
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
Source§fn after_vm_execution(
&mut self,
_state: &mut ZkSyncVmState<S, H>,
_bootloader_state: &BootloaderState,
_stop_reason: VmExecutionStopReason,
)
fn after_vm_execution( &mut self, _state: &mut ZkSyncVmState<S, H>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
§fn initialize_tracer(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
)
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, )
§fn finish_cycle(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
_bootloader_state: &mut BootloaderState,
) -> TracerExecutionStatus
fn finish_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, ) -> TracerExecutionStatus
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
Source§fn after_vm_execution(
&mut self,
_state: &mut ZkSyncVmState<S, H>,
_bootloader_state: &BootloaderState,
_stop_reason: VmExecutionStopReason,
)
fn after_vm_execution( &mut self, _state: &mut ZkSyncVmState<S, H>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
§fn initialize_tracer(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
)
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, )
§fn finish_cycle(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>,
_bootloader_state: &mut BootloaderState,
) -> TracerExecutionStatus
fn finish_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, ) -> TracerExecutionStatus
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
Source§fn after_vm_execution(
&mut self,
_state: &mut ZkSyncVmState<S, H>,
_bootloader_state: &BootloaderState,
_stop_reason: VmExecutionStopReason,
)
fn after_vm_execution( &mut self, _state: &mut ZkSyncVmState<S, H>, _bootloader_state: &BootloaderState, _stop_reason: VmExecutionStopReason, )
§fn initialize_tracer(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>,
)
fn initialize_tracer( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, )
§fn finish_cycle(
&mut self,
_state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>,
_bootloader_state: &mut BootloaderState,
) -> TracerExecutionStatus
fn finish_cycle( &mut self, _state: &mut VmState<StorageOracle<S, H>, SimpleMemory<H>, InMemoryEventSink<H>, PrecompilesProcessorWithHistory<false, H>, DecommitterOracle<false, S, H>, DummyTracer>, _bootloader_state: &mut BootloaderState, ) -> TracerExecutionStatus
Source§impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
impl<S: WriteStorage, H: HistoryMode> VmTracer<S, H> for BootloaderDebugTracer
fn save_results(&mut self, _result: &mut VmExecutionResultAndLogs)
Auto Trait Implementations§
impl Freeze for BootloaderDebugTracer
impl RefUnwindSafe for BootloaderDebugTracer
impl Send for BootloaderDebugTracer
impl Sync for BootloaderDebugTracer
impl Unpin for BootloaderDebugTracer
impl UnwindSafe for BootloaderDebugTracer
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> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<S, H, T> MultiVmTracer<S, H> for Twhere
S: WriteStorage,
H: HistoryMode,
T: IntoLatestTracer<S, H> + IntoVmVirtualBlocksTracer<S, H> + IntoVmRefundsEnhancementTracer<S, H> + IntoVmBoojumIntegrationTracer<S, H> + IntoVm1_4_1IntegrationTracer<S, H> + IntoVm1_4_2IntegrationTracer<S, H> + IntoOldVmTracer,
impl<S, H, T> MultiVmTracer<S, H> for Twhere
S: WriteStorage,
H: HistoryMode,
T: IntoLatestTracer<S, H> + IntoVmVirtualBlocksTracer<S, H> + IntoVmRefundsEnhancementTracer<S, H> + IntoVmBoojumIntegrationTracer<S, H> + IntoVm1_4_1IntegrationTracer<S, H> + IntoVm1_4_2IntegrationTracer<S, H> + IntoOldVmTracer,
fn into_tracer_pointer(self) -> Box<dyn MultiVmTracer<S, H>>where
Self: Sized + 'static,
§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>
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);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.