pub struct OutputBuffer { /* private fields */ }Implementations§
Source§impl OutputBuffer
impl OutputBuffer
Sourcepub fn new(
log: StructuredLogBuilder,
shell_name: String,
shell_marker: String,
) -> Self
pub fn new( log: StructuredLogBuilder, shell_name: String, shell_marker: String, ) -> Self
Construct an OutputBuffer wired to the given log builder.
append/consume_*/clear emit their corresponding buffer events
on log while still holding the inner mutex, preventing a race
between byte appends and event order. The inner mutex is a
std::sync::Mutex - every critical section is pure CPU work, so no
.await ever happens under the guard and a blocking lock is correct.
pub async fn append(&self, bytes: &[u8])
Sourcepub async fn consume_literal(
&self,
needle: &str,
) -> Option<(Match<LiteralMatch>, EventSeq)>
pub async fn consume_literal( &self, needle: &str, ) -> Option<(Match<LiteralMatch>, EventSeq)>
Find literal, drain the decoded prefix up to the match end, push the
Matched buffer event while still holding the inner lock, and return
the match plus the EventSeq of the just-pushed buffer event. All
under one lock.
Sourcepub async fn consume_regex(
&self,
re: &Regex,
) -> Option<(Match<RegexMatch>, EventSeq)>
pub async fn consume_regex( &self, re: &Regex, ) -> Option<(Match<RegexMatch>, EventSeq)>
Find regex, drain via split_to, push the Matched buffer event,
and return the match plus the EventSeq of the just-pushed
buffer event. All under one lock.
Guards against partial-line matches: if the match ends at the buffer
boundary and the buffer does not end with a newline, the last line may
still be arriving. In that case we return None so the caller waits
for more data rather than consuming an incomplete line.
Sourcepub async fn fail_check_consume_literal(
&self,
needle: &str,
fail_pattern: Option<&FailPattern>,
) -> Result<Option<(Match<LiteralMatch>, EventSeq)>, FailPatternHit>
pub async fn fail_check_consume_literal( &self, needle: &str, fail_pattern: Option<&FailPattern>, ) -> Result<Option<(Match<LiteralMatch>, EventSeq)>, FailPatternHit>
Check fail pattern against buffer, then try to consume literal - under one lock.
Returns Err if fail pattern found, Ok(Some) if literal consumed, Ok(None) if not found.
On success the Matched buffer event is pushed before releasing the lock.
Sourcepub async fn fail_check_consume_regex(
&self,
re: &Regex,
fail_pattern: Option<&FailPattern>,
) -> Result<Option<(Match<RegexMatch>, EventSeq)>, FailPatternHit>
pub async fn fail_check_consume_regex( &self, re: &Regex, fail_pattern: Option<&FailPattern>, ) -> Result<Option<(Match<RegexMatch>, EventSeq)>, FailPatternHit>
Check fail pattern against buffer, then try to consume regex - under one lock.
Returns Err if fail pattern found, Ok(Some) if regex consumed, Ok(None) if not found.
On success the Matched buffer event is pushed before releasing the lock.
Sourcepub async fn multimatch_scan(
&self,
slots: &mut [PatternSlot],
block_entry: usize,
) -> Vec<Option<MultiMatchHit>>
pub async fn multimatch_scan( &self, slots: &mut [PatternSlot], block_entry: usize, ) -> Vec<Option<MultiMatchHit>>
Scan every still-unmatched slot against the current decoded buffer
without draining and without checking fail patterns. Returns,
per slot index, an Option<MultiMatchHit> (Some iff the slot
matched this round). Regex slots respect the partial-line guard.
block_entry is the absolute offset of the multimatch block’s entry
point. The scan operates against decoded[block_entry - base ..].
Sourcepub async fn drain_to(&self, target: usize)
pub async fn drain_to(&self, target: usize)
Drop the prefix of decoded up to absolute offset target without
emitting any buffer event. Used at multimatch block exit to advance
past max(end_abs) across all pattern hits in a single step.
Sourcepub async fn base_offset(&self) -> usize
pub async fn base_offset(&self) -> usize
Current absolute base offset - the byte position in this shell’s
lifetime stream where decoded starts. Used by the VM at multimatch
block entry so the loop’s scan operates in absolute coordinates that
remain stable across in-block Grew appends.
Sourcepub fn push_multimatch_matched_event(
&self,
before: String,
matched: String,
after: String,
) -> EventSeq
pub fn push_multimatch_matched_event( &self, before: String, matched: String, after: String, ) -> EventSeq
Push a Matched buffer event for a multimatch per-pattern hit.
Same before/matched/after shape as single-match, but does
not drain - the actual drain happens once at block exit via
drain_to. Returns the EventSeq of the just-emitted event.
Sourcepub async fn check_fail_pattern(
&self,
fail_pattern: Option<&FailPattern>,
) -> Option<FailPatternHit>
pub async fn check_fail_pattern( &self, fail_pattern: Option<&FailPattern>, ) -> Option<FailPatternHit>
Check fail pattern against current buffer (peek only, no drain).
Sourcepub async fn clear(&self) -> String
pub async fn clear(&self) -> String
Drain the cleanly-decoded portion of the buffer, advancing base.
Trailing bytes of an incomplete UTF-8 sequence stay carried over inside
Utf8Stream, to be completed by a future append. Emits a Reset
buffer event carrying the consumed prefix - byte-identical to the
concatenation of Grew payloads emitted since the previous reset -
before releasing the lock. Returns the consumed prefix.
Sourcepub async fn snapshot_tail(&self, n: usize) -> String
pub async fn snapshot_tail(&self, n: usize) -> String
Return the tail of the current buffer (last n chars) as a string.
Trait Implementations§
Source§impl Clone for OutputBuffer
impl Clone for OutputBuffer
Source§fn clone(&self) -> OutputBuffer
fn clone(&self) -> OutputBuffer
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for OutputBuffer
impl RefUnwindSafe for OutputBuffer
impl Send for OutputBuffer
impl Sync for OutputBuffer
impl Unpin for OutputBuffer
impl UnsafeUnpin for OutputBuffer
impl UnwindSafe for OutputBuffer
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);