types

local types = require("@std/path/win32/types")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
Path	A structured Windows path.
PathData	The raw data of a Windows path: an array of components, the path kind, and an optional drive letter.
PathKind	Describes how a Windows path is rooted:
Pathlike	Anything that can be used as a Windows path: a string, a Path, or raw PathData.

---

Types

Path

A structured Windows path.

type Path = setmetatable<PathData, pathinterface.PathInterface>

---

PathData

The raw data of a Windows path: an array of components, the path kind, and an optional drive letter.

type PathData = {
	parts: { string },
	kind: PathKind,
	drive: string?,
}

---

PathKind

Describes how a Windows path is rooted:

• "absolute": Drive-rooted path, e.g. C:\foo.

• "unc": UNC path, e.g. \\server\share.

• "relative": A path with no drive or UNC root.

type PathKind = "unc" | "absolute" | "relative"

---

Pathlike

Anything that can be used as a Windows path: a string, a Path, or raw PathData.

type Pathlike = string | PathData | Path

---