# LibTmux.ScreenWaitResult

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** Julia
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-julia/blob/1a68a11f071686736937d027b190b43cf946c385/src/screen_wait.jl#L4
- **Page:** https://libtmux.org/en/julia/latest/reference/libtmux-screenwaitresult/

```
LibTmux.ScreenWaitResult(
    text::String,
    source::Symbol,
    matched_at_entry::Bool,
    dropped_bytes::Int64,
)

LibTmux.ScreenWaitResult(
    text,
    source,
    matched_at_entry,
    dropped_bytes,
)
```

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`.

A screen wait has no stream, so unlike [`OutputWaitResult`](/en/julia/latest/reference/libtmux-outputwaitresult/) it 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

### `ScreenWaitResult` (overload 1)

```julia
LibTmux.ScreenWaitResult(
    text::String,
    source::Symbol,
    matched_at_entry::Bool,
    dropped_bytes::Int64,
)
```

[Source](https://github.com/libtmux/libtmux-julia/blob/1a68a11f071686736937d027b190b43cf946c385/src/screen_wait.jl#L17).

### `ScreenWaitResult` (overload 2)

```julia
LibTmux.ScreenWaitResult(
    text,
    source,
    matched_at_entry,
    dropped_bytes,
)
```

[Source](https://github.com/libtmux/libtmux-julia/blob/1a68a11f071686736937d027b190b43cf946c385/src/screen_wait.jl#L17).

## Parameters

- `text` (`String`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1]`)
- `source` (`Symbol`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1]`)
- `matched_at_entry` (`Bool`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1]`)
- `dropped_bytes` (`Int64`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 1]`)
- `text` (`Any`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2]`)
- `source` (`Any`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2]`)
- `matched_at_entry` (`Any`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2]`)
- `dropped_bytes` (`Any`) (for `ScreenWaitResult(text, source, matched_at_entry, dropped_bytes) [overload 2]`)

## Members

### Common operations

- [`matched_at_entry`](/en/julia/latest/reference/libtmux-screenwaitresult-matched_at_entry/) (property)

### Other members

- [`dropped_bytes`](/en/julia/latest/reference/libtmux-screenwaitresult-dropped_bytes/) (property)
- [`source`](/en/julia/latest/reference/libtmux-screenwaitresult-source/) (property)
- [`text`](/en/julia/latest/reference/libtmux-screenwaitresult-text/) (property)

## Guides

Pages that discuss `ScreenWaitResult`.

- [Observing output](/en/julia/latest/topics/observations/)