Path¶

[Source]

Operations on paths that do not require a capability. The operations can be used to manipulate path names, but give no access to the resulting paths.

All paths use / as the separator on every platform, including Windows. Paths obtained through Path.cwd() and Path.canonical() are already /-separated. clean() normalizes any remaining \ on Windows. is_sep() still accepts \ on Windows for parsing external input. Use to_os() when a backslash path is needed for Windows shell commands.

primitive val Path

Constructors¶

create¶

[Source]

new val create()
: Path val^

Returns¶

Path val^

Public Functions¶

is_sep¶

[Source]

Determine if a byte is a path separator.

fun box is_sep(
  c: U8 val)
: Bool val

Parameters¶

c: U8 val

Returns¶

Bool val

sep¶

[Source]

Return the path separator as a string.

fun tag sep()
: String val

Returns¶

String val

is_abs¶

[Source]

Return true if the path is an absolute path.

fun box is_abs(
  path: String val)
: Bool val

Parameters¶

path: String val

Returns¶

Bool val

join¶

[Source]

Join two paths together. If the next_path is absolute, simply return it. The returned path will be cleaned.

fun box join(
  path: String val,
  next_path: String val)
: String val

Parameters¶

path: String val
next_path: String val

Returns¶

String val

clean¶

[Source]

Replace multiple separators with a single /. On Windows, normalize \ to /. Remove instances of . from the path. Remove instances of .. and the preceding path element from the path. A leading // (exactly two separators) is preserved as a network path prefix per POSIX; three or more leading separators collapse to one. The result will have no trailing slash unless it is a root directory. If the result would be empty, "." will be returned instead.

fun box clean(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

normcase¶

[Source]

Lowercases the path on case-insensitive platforms (Windows, macOS). Returns the path unchanged on case-sensitive platforms.

fun box normcase(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

cwd¶

[Source]

Returns the program's working directory. Setting the working directory is not supported, as it is not concurrency-safe.

fun box cwd()
: String val

Returns¶

String val

abs¶

[Source]

Returns a cleaned, absolute path.

fun box abs(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

rel¶

[Source]

Returns a path such that Path.join(to, Path.rel(to, target)) == target. Raises an error if this isn't possible.

fun box rel(
  to: String val,
  target: String val)
: String val ?

Parameters¶

to: String val
target: String val

Returns¶

String val ?

split¶

[Source]

Splits the path into a pair, (head, tail) where tail is the last pathname component and head is everything leading up to that. The tail part will never contain a slash; if path ends in a slash, tail will be empty. If there is no slash in path, head will be empty. If path is empty, both head and tail are empty. The path in head will be cleaned before it is returned. In all cases, join(head, tail) returns a path to the same location as path (but the strings may differ). Also see the functions dir() and base().

fun box split(
  path: String val,
  separator: String val = Path.sep())
: (String val , String val)

Parameters¶

path: String val
separator: String val = Path.sep()

Returns¶

(String val , String val)

base¶

[Source]

Return the path after the last separator, or the whole path if there is no separator. If with_ext is false, the extension as defined by the ext() method will be omitted from the result.

fun box base(
  path: String val,
  with_ext: Bool val = true)
: String val

Parameters¶

path: String val
with_ext: Bool val = true

Returns¶

String val

dir¶

[Source]

Return a cleaned path before the last separator, or the whole path if there is no separator.

fun box dir(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

ext¶

[Source]

Return the file extension, i.e. the part after the last dot as long as that dot is after all separators. Return an empty string for no extension.

fun box ext(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

volume¶

[Source]

Return the volume at the beginning of the path, if there is one.

On Windows, this includes drive letters (C:), extended-length prefixes (\\?\), and UNC bases (\\server\share).

On all platforms, a path beginning with exactly two separators followed by a non-separator is treated as a network path (//host/share), matching the POSIX rule that a pathname beginning with exactly two slashes is implementation-defined. Three or more leading slashes are not a network path and collapse to one in clean().

fun box volume(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

to_os¶

[Source]

Convert forward slashes to the OS native separator. On Windows this replaces / with \; on all other platforms it returns path unchanged.

Use when passing a path to cmd.exe or another Windows tool that interprets / as an option flag.

fun box to_os(
  path: String val)
: String val

Parameters¶

path: String val

Returns¶

String val

canonical¶

[Source]

Return the equivalent canonical absolute path. Raise an error if there isn't one.

fun box canonical(
  path: String val)
: String val ?

Parameters¶

path: String val

Returns¶

String val ?

is_list_sep¶

[Source]

Determine if a byte is a path list separator.

fun box is_list_sep(
  c: U8 val)
: Bool val

Parameters¶

c: U8 val

Returns¶

Bool val

list_sep¶

[Source]

Return the path list separator as a string.

fun box list_sep()
: String val

Returns¶

String val

split_list¶

[Source]

Separate a list of paths into an array of cleaned paths.

fun box split_list(
  path: String val)
: Array[String val] iso^

Parameters¶

path: String val

Returns¶

Array[String val] iso^

random¶

[Source]

Returns a pseudo-random base, suitable as a temporary file name or directory name, but not guaranteed to not already exist.

fun box random(
  len: USize val = 6)
: String val

Parameters¶

len: USize val = 6

Returns¶

String val

eq¶

[Source]

fun box eq(
  that: Path val)
: Bool val

Parameters¶

that: Path val

Returns¶

Bool val

ne¶

[Source]

fun box ne(
  that: Path val)
: Bool val

Parameters¶

that: Path val

Returns¶

Bool val