ketraterm-completion/io.github.ketraterm.completion.api/TerminalDirectoryListingRequest

TerminalDirectoryListingRequest

data class TerminalDirectoryListingRequest(val workingDirectoryUri: String, val directoryPrefix: String, val entryNamePrefix: String)

Host-resolved directory-listing request used by path completion.

The completion engine deliberately keeps directoryPrefix lexical. The host owns interpreting drive roots, UNC paths, home-directory prefixes, and the authority of workingDirectoryUri for its actual file-system context. Implementations resolve and load the requested directory suspendingly.

Throws

IllegalArgumentException

if the URI is blank, the directory prefix is not empty and separator-terminated, or the entry prefix contains a separator.

Constructors

TerminalDirectoryListingRequest

constructor(workingDirectoryUri: String, directoryPrefix: String, entryNamePrefix: String)

Properties

directoryPrefix

val directoryPrefix: String

typed path portion ending at the final separator; forward slashes are used as a transport-neutral separator. An empty value addresses the working directory and ~/ addresses the host user's home.

entryNamePrefix

val entryNamePrefix: String

typed base-name prefix after the final separator.

workingDirectoryUri

val workingDirectoryUri: String

absolute host-reported working-directory URI.