Server.ValidateLayoutsAsync
Checks layouts before a workspace changes the server.
Source and package
- Module
- LibTmux
- Declared in
- Server
- Package
- LibTmux
- Source
- src/LibTmux/Server.Layout.cs
- ValidateLayoutsAsync ( layouts : IEnumerable<(string Layout, int PaneCount)> , cancellationToken : Cancellation
Token ) Task -
Description#
Checks custom syntax, checksums, and minimum cell counts without checking geometry. Version-sensitive names use the daemon version, or the client version when no daemon is running. This never starts or changes a server.
- Parameters
-
-
layouts ( IEnumerable<(string Layout, int PaneCount)> ) – Layouts and the number of panes each must accommodate.
-
cancellationToken ( Cancellation
Token ) – Cancels version discovery.
-
- Returns
-
A task completing when every layout is safe to send.
- Raises
-
-
Argument
Null – The layouts collection is null.Exception -
Argument
Exception – A layout or pane count is invalid. -
Invalid
Data – The daemon version reply is malformed.Exception -
Operation
Canceled – Validation was canceled.Exception -
Stale
Server – The daemon changed.Generation Exception -
Tmux
Command – The daemon version query failed.Exception
-