ScreenWaitResult
One accepted screen wait. text is the screen of the matching read, cut to a tail of at most max_bytes bytes, and dropped_bytes counts the bytes cut from its head. When max_bytes cuts the screen, the match can lie in the dropped head, so text need not contain it. matched_at_entry is true exactly when the match was on the entry read, and then source == :baseline; otherwise source == :output.
Source and package
- Qualified name
-
LibTmux .Screen Wait Result - Module
- LibTmux
- Package
- LibTmux
- Source
- src/screen_wait.jl
- Lib
Tmux .ScreenWaitResult( text::String, source::Symbol, matched_at ::Bool, dropped_entry _bytes ::Int64, )LibTmux .ScreenWaitResult( text, source, matched_at , dropped_entry _bytes , ) -
Description#
A screen wait has no stream, so unlike
OutputWaitResultit carries no cursor and no received or pending byte counts. A match is evidence that the text was on the screen, not that a process succeeded.Methods#
Lib
Tmux .ScreenWaitResult( text::String, source::Symbol, matched_at ::Bool, dropped_entry _bytes ::Int64, )[source]#Lib
Tmux .ScreenWaitResult( text, source, matched_at , dropped_entry _bytes , )[source]#- Parameters
-
-
text(String) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1] -
source(Symbol) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1] -
matched_at_entry(Bool) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1] -
dropped_bytes(Int64) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1] -
text(Any) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2] -
source(Any) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2] -
matched_at_entry(Any) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2] -
dropped_bytes(Any) # forScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2]
-
Guides#
Pages that discuss ScreenWaitResult.