# LibTmux.FormatUpdate

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** Julia
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/observation.jl#L45
- **Bases:** [`LibTmux.ObservationEvent`](/en/julia/latest/reference/libtmux-observationevent/)
- **Page:** https://libtmux.org/en/julia/latest/reference/libtmux-formatupdate/

```
LibTmux.FormatUpdate(
    field::String,
    bytes::Vector{UInt8},
    session::LibTmux.SessionRef,
    window::Union{Nothing, LibTmux.WindowRef},
    window_index::Union{Nothing, Int64},
    pane::Union{Nothing, LibTmux.PaneRef},
    cursor::LibTmux.ObservationCursor
)

LibTmux.FormatUpdate(field, bytes, session, window, window_index, pane, cursor)
```

One sampled format field, with session and window-link context. `bytes` retains the field codec's escaped value; `window_index` is tmux's contextual index. Optional window/pane references distinguish session-level updates. Pane values may repeat for multiple links; their context is preserved rather than deduplicated.

## Methods

### `FormatUpdate` (overload 1)

```julia
LibTmux.FormatUpdate(
    field::String,
    bytes::Vector{UInt8},
    session::LibTmux.SessionRef,
    window::Union{Nothing, LibTmux.WindowRef},
    window_index::Union{Nothing, Int64},
    pane::Union{Nothing, LibTmux.PaneRef},
    cursor::LibTmux.ObservationCursor
)
```

[Source](https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/observation.jl#L52).

### `LibTmux.FormatUpdate(field, bytes, session, window, window_index, pane, cursor)`

[Source](https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/observation.jl#L52).

## Parameters

- `field` (`String`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `bytes` (`Base.Vector{UInt8}`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `session` (`LibTmux.SessionRef`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `window` (`Union{Nothing, LibTmux.WindowRef}`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `window_index` (`Union{Nothing, Int64}`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `pane` (`Union{Nothing, LibTmux.PaneRef}`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `cursor` (`LibTmux.ObservationCursor`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 1]`)
- `field` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `bytes` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `session` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `window` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `window_index` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `pane` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)
- `cursor` (`Any`) (for `FormatUpdate(field, bytes, session, window, window_index, pane, cursor) [overload 2]`)

## Members

### Other members

- `bytes` (property)
- `cursor` (property)
- `field` (property)
- `pane` (property)
- `session` (property)
- `window` (property)
- `window_index` (property)