# LibTmux.FormatHints

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** Julia
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/formats.jl#L180
- **Page:** https://libtmux.org/en/julia/latest/reference/libtmux-formathints/

```
LibTmux.FormatHints(
    candidate_names::Vector{String},
    result::LibTmux.CommandResult,
    availability::Symbol,
    complete::Bool
)

LibTmux.FormatHints(candidate_names, result, availability, complete)
```

Unverified candidate names from tmux's unescaped format listing. `result` retains bounded raw command evidence. `availability` is `:unverified` and `complete` is `false`; candidate names do not prove variable support.

## Methods

### `FormatHints` (overload 1)

```julia
LibTmux.FormatHints(
    candidate_names::Vector{String},
    result::LibTmux.CommandResult,
    availability::Symbol,
    complete::Bool
)
```

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

### `LibTmux.FormatHints(candidate_names, result, availability, complete)`

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

## Parameters

- `candidate_names` (`Base.Vector{String}`) (for `FormatHints(candidate_names, result, availability, complete) [overload 1]`)
- `result` (`LibTmux.CommandResult`) (for `FormatHints(candidate_names, result, availability, complete) [overload 1]`)
- `availability` (`Symbol`) (for `FormatHints(candidate_names, result, availability, complete) [overload 1]`)
- `complete` (`Bool`) (for `FormatHints(candidate_names, result, availability, complete) [overload 1]`)
- `candidate_names` (`Any`) (for `FormatHints(candidate_names, result, availability, complete) [overload 2]`)
- `result` (`Any`) (for `FormatHints(candidate_names, result, availability, complete) [overload 2]`)
- `availability` (`Any`) (for `FormatHints(candidate_names, result, availability, complete) [overload 2]`)
- `complete` (`Any`) (for `FormatHints(candidate_names, result, availability, complete) [overload 2]`)

## Members

### Other members

- `availability` (property)
- `candidate_names` (property)
- `complete` (property)
- `result` (property)