libtmux.workspace:read-workspace
- (read-workspace path &rest options &key (max-input-bytes +default-max-input-bytes+) &allow-other-keys)
-
Public owner:
libtmux.workspaceRead one bounded regular UTF-8 JSON file and return an owned WORKSPACE. PATH is opened for input and never modified. MAX-INPUT-BYTES is enforced on bytes read even if the file changes after opening. The descriptor is opened nonblocking, then directories and special files are rejected before reading. Other OPTIONS are forwarded to PARSE-WORKSPACE. Signals INVALID-WORKSPACE-DOCUMENT or WORKSPACE-LIMIT-EXCEEDED and closes the stream.
Description#
See also:
libtmux.workspace:parse-workspace,libtmux.workspace:workspace-data.
Guides#
Pages that discuss read-workspace.