files.validate¶

files.validate says whether a path exists and whether it is a directory. It reports a path that the daemon cannot examine in the response, not as a JSON-RPC error.

Request¶

{"path": "/repo"}

Parameter	Required	Meaning
`path`	no	The path to examine. Path handling has the rules for a leading `~` and for a name that is not valid UTF-8.

The daemon does not refuse a request without path. It answers as for a path that does not exist.

Response¶

{"valid": true, "isDir": true}

Member	Meaning
`valid`	If the path exists, `true`.
`isDir`	If the path is a directory, `true`.
`error`	The reason for `"valid": false`. A response with `"valid": true` has no `error` member.

valid says that the path exists. It does not say that the daemon can read the file or list the directory.

If the path does not exist:

{"valid": false, "isDir": false, "error": "Path does not exist"}

If the daemon cannot examine the path, error holds the text of the operating system in the form stat <path>: <reason>. For example, a component of the path is a regular file (not a directory). See Stat failures. The text holds path after the ~ expansion. The text is that of Linux and macOS. On Windows the operating system gives other texts.

The daemon follows a symbolic link. The response then describes the target of the link. A link to a target that does not exist gives "valid": false.

Errors¶

This method has no errorCode member. It has one JSON-RPC error.

Code	Text	Cause
`-32602`	`Invalid params`	The request has no `params` member, or `params` or a member of it has the wrong type. See the rules for `params`.

Differences from the reference¶

claustrum is built to answer as the reference daemon does. One entry of the divergence catalog applies to this method:

D9: a maxBytes member of the wrong type gets -32602, although this method does not use maxBytes. The entry has the measured case, on files.stat.