io.github.libtmux.Layouts.Layouts

class io.github.libtmux.Layouts.Layouts

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.Layouts.Layouts

Which layout names are safe to hand to tmux.

<p>Public because every path that can reach select-layout needs it, not only the one that reads a workspace file. This check exists because an unrecognised layout name does not produce an error on every tmux: on 3.3a it crashes the server, taking down every session on that socket, including ones this program never created. A workspace file is user-supplied text, so the name has to be checked before it is dispatched rather than after tmux has had it.

<p>tmux accepts either one of its named layouts or a serialized layout carrying tmux's own checksum. The checksum is verified here; a four-hex-digit prefix alone does not make the rest safe for tmux to parse.

Members

• require method Returns the layout unchanged, having checked tmux will recognise it.
• requireSerialized method Requires an exact layout string rather than a built-in layout name.