README
U
UnixDirectory
U
UnixFile
U
WinDirectory
U
WinFile
Tr
IsString
Tr
PlatformPath
- ::iterDirectory::iter
- ::lengthDirectory::length
- ::newDirectory::new
- ::op_getDirectory::op_get
- ::subDirectory::sub
- ::extensionFile::extension
- ::newFile::new
- ::directoryPath::directory
- ::filePath::file
- ::is_absolutePath::is_absolute
- ::is_relativePath::is_relative
- ::is_root_pathPath::is_root_path
- ::parsePath::parse
- ::prefixPath::prefix
- ::add_directoryPathBuilder::add_directory
- ::from_pathPathBuilder::from_path
- ::set_basenamePathBuilder::set_basename
- ::set_extensionPathBuilder::set_extension
- ::set_filePathBuilder::set_file
- ::to_pathPathBuilder::to_path
- ::is_absoluteUnixPath::is_absolute
- ::is_relativeUnixPath::is_relative
- ::newUnixPath::new
T
UnixPathComponent
- ::is_absoluteWinPath::is_absolute
- ::is_relativeWinPath::is_relative
- ::is_root_pathWinPath::is_root_path
- ::newWinPath::new
T
WinPathComponent
T
WinPrefix

path

A cross-platform path manipulation library for MoonBit that provides robust handling of both Unix and Windows file system paths with automatic format detection and type-safe path operations.

path

filepath

filesystem

cross-platform

unix

windows

parsing

file-handling

path-manipulation

#illusory0x0/path

A MoonBit library for cross-platform path manipulation, supporting both Unix and Windows path styles with type-safe operations.

#Examples

#PathBuilder Usage

Demonstrates building paths using PathBuilder from a relative path.

///|
test {
  let path = @path.Path::parse("./projects/")
  let builder = @path.PathBuilder::from_path(path)
  builder.set_extension("md")
  builder.set_basename("README")
  inspect(builder, content="projects/README.md")
  builder.add_directory("proj_1")

  // pop last file, and add new directory
  inspect(builder, content="projects/proj_1/")
}

Demonstrates building paths using PathBuilder from a Windows absolute path.

///|
test {
  let path = @path.Path::parse("C:\\projects\\")
  let builder = @path.PathBuilder::from_path(path)
  builder.set_file(base="README", extension="md")
  inspect(builder, content="C:\\projects\\README.md")
  builder.add_directory("proj_1")

  // pop last file, and add new directory
  inspect(builder, content="C:\\projects\\proj_1\\")
}

#Simple Usage

Shows basic path operations like extracting file name, directory, and prefix.

///|
test "Simple String Operations" {
  let path = @path.Path::parse("C:\\Users\\username\\Documents\\file.txt")
  inspect(path.file(), content="Some(file.txt)")
  inspect(path.directory()[:].join("\\"), content="Users\\username\\Documents")
  inspect(path.prefix(), content="C:\\")
}

#Type Safe Operations

Illustrates type-safe access to directory components for Unix paths.

///|
test "type safe directory components" {
  let path = @path.Path::parse("/home/username/proj/src/")
  guard path is UPath(path) else { panic() }
  let parent_dir : ArrayView[@path.UnixPathComponent] = path.directory[0:path.directory.length() -
    1]
  @json.inspect(parent_dir, content=[
    ["UnixPathComponent", "home"],
    ["UnixPathComponent", "username"],
    ["UnixPathComponent", "proj"],
  ])
}

#Path Kinds Examples

Examples of different path kinds: relative and absolute for Unix and Windows.

///|
test "Unix relative path" {
  let path = @path.Path::parse("home/username/proj/src/README.mbt.md")
  inspect(path.directory(), content="home/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="false")
}

///|
test "Unix absolute path" {
  let path = @path.Path::parse("/home/username/proj/src/README.mbt.md")
  inspect(path.directory(), content="home/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="true")
  inspect(path.is_relative(), content="false")
  inspect(path.is_root_path(), content="true")
}

///|
test "Windows relative path" {
  let path = @path.Path::parse("Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="false")
}

///|
test "Windows absolute path" {
  let path = @path.Path::parse("C:\\Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="true")
  inspect(path.is_relative(), content="false")
  inspect(path.is_root_path(), content="true")
}

///|
test "Windows relative root path" {
  let path = @path.Path::parse("\\Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="true")
}

#illusory0x0/path

A MoonBit library for cross-platform path manipulation, supporting both Unix and Windows path styles with type-safe operations.

#Examples

#PathBuilder Usage

Demonstrates building paths using PathBuilder from a relative path.

///|
test {
  let path = @path.Path::parse("./projects/")
  let builder = @path.PathBuilder::from_path(path)
  builder.set_extension("md")
  builder.set_basename("README")
  inspect(builder, content="projects/README.md")
  builder.add_directory("proj_1")

  // pop last file, and add new directory
  inspect(builder, content="projects/proj_1/")
}

Demonstrates building paths using PathBuilder from a Windows absolute path.

///|
test {
  let path = @path.Path::parse("C:\\projects\\")
  let builder = @path.PathBuilder::from_path(path)
  builder.set_file(base="README", extension="md")
  inspect(builder, content="C:\\projects\\README.md")
  builder.add_directory("proj_1")

  // pop last file, and add new directory
  inspect(builder, content="C:\\projects\\proj_1\\")
}

#Simple Usage

Shows basic path operations like extracting file name, directory, and prefix.

///|
test "Simple String Operations" {
  let path = @path.Path::parse("C:\\Users\\username\\Documents\\file.txt")
  inspect(path.file(), content="Some(file.txt)")
  inspect(path.directory()[:].join("\\"), content="Users\\username\\Documents")
  inspect(path.prefix(), content="C:\\")
}

#Type Safe Operations

Illustrates type-safe access to directory components for Unix paths.

///|
test "type safe directory components" {
  let path = @path.Path::parse("/home/username/proj/src/")
  guard path is UPath(path) else { panic() }
  let parent_dir : ArrayView[@path.UnixPathComponent] = path.directory[0:path.directory.length() -
    1]
  @json.inspect(parent_dir, content=[
    ["UnixPathComponent", "home"],
    ["UnixPathComponent", "username"],
    ["UnixPathComponent", "proj"],
  ])
}

#Path Kinds Examples

Examples of different path kinds: relative and absolute for Unix and Windows.

///|
test "Unix relative path" {
  let path = @path.Path::parse("home/username/proj/src/README.mbt.md")
  inspect(path.directory(), content="home/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="false")
}

///|
test "Unix absolute path" {
  let path = @path.Path::parse("/home/username/proj/src/README.mbt.md")
  inspect(path.directory(), content="home/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="true")
  inspect(path.is_relative(), content="false")
  inspect(path.is_root_path(), content="true")
}

///|
test "Windows relative path" {
  let path = @path.Path::parse("Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="false")
}

///|
test "Windows absolute path" {
  let path = @path.Path::parse("C:\\Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="true")
  inspect(path.is_relative(), content="false")
  inspect(path.is_root_path(), content="true")
}

///|
test "Windows relative root path" {
  let path = @path.Path::parse("\\Users\\username\\proj\\src\\README.mbt.md")
  // This is used for Debug output
  inspect(path.directory(), content="Users/username/proj/src/")
  inspect(path.file().unwrap(), content="README.mbt.md")
  inspect(path.is_absolute(), content="false")
  inspect(path.is_relative(), content="true")
  inspect(path.is_root_path(), content="true")
}

UnixDirectory

source

typealias Directory[UnixPathComponent] as UnixDirectory

UnixFile

source

typealias File[UnixPathComponent] as UnixFile

WinDirectory

source

typealias Directory[WinPathComponent] as WinDirectory

WinFile

source

typealias File[WinPathComponent] as WinFile

IsString

source

trait IsString

impl IsString for String

impl IsString for StringView

PlatformPath

source

trait PlatformPath

PathError

source

pub(all) suberror PathError {
  PathError(Int, String)
}

impl Show for PathError

Directory::iter

source

fn[T] Directory::iter(self : Directory[T]) -> Iter[T]

Directory::length

source

fn[T] Directory::length(self : Directory[T]) -> Int

Directory::new

source

fn[A : PlatformPath] Directory::new(components : ArrayView[StringView]) -> Directory[A] raise PathError

Directory::op_get

source

fn[T] Directory::op_get(self : Directory[T], index : Int) -> T

Directory::sub

source

#alias("_[_:_]")
fn[T] Directory::sub(self : Directory[T], start? : Int, end? : Int) -> ArrayView[T]

File

source

pub struct File[Component] {
  base : Component
  extension : Component?
}

impl Eq for File[Component]

impl Hash for File[Component]

impl Show for File[A]

impl ToJson for File[Component]

File::extension

source

fn[A : IsString] File::extension(self : File[A]) -> String?

File::new

source

fn[A : PlatformPath] File::new(base~ : StringView, extension? : StringView) -> File[A] raise PathError

Path

source

pub(all) enum Path {
  WPath(WinPath)
  UPath(UnixPath)
}

impl Eq for Path

impl Hash for Path

impl Show for Path

impl ToJson for Path

Path::directory

source

fn Path::directory(self : Path) -> Directory[String]

Path::file

source

fn Path::file(self : Path) -> File[String]?

Path::is_absolute

source

fn Path::is_absolute(self : Path) -> Bool

Path::is_relative

source

fn Path::is_relative(self : Path) -> Bool

Path::is_root_path

source

fn Path::is_root_path(self : Path) -> Bool

Path::parse

source

fn Path::parse(path : StringView) -> Path raise PathError

Parsing path from string used prefix based detection to determine the path format style (Windows/Unix)

Path::prefix

source

fn Path::prefix(self : Path) -> String

PathBuilder

source

type PathBuilder

impl Show for PathBuilder

PathBuilder::add_directory

source

fn PathBuilder::add_directory(self : PathBuilder, directory : StringView) -> Unit raise PathError

When PathBuilder contains filename add_directory would pop this filename, and then add directory in its parent directory

PathBuilder::from_path

source

fn PathBuilder::from_path(path : Path) -> PathBuilder

PathBuilder::set_basename

source

fn PathBuilder::set_basename(self : PathBuilder, basename : StringView) -> Unit raise PathError

PathBuilder::set_extension

source

fn PathBuilder::set_extension(self : PathBuilder, extension : StringView) -> Unit raise PathError

PathBuilder::set_file

source

fn PathBuilder::set_file(self : PathBuilder, base~ : StringView, extension~ : StringView) -> Unit raise PathError

PathBuilder::to_path

source

fn PathBuilder::to_path(self : PathBuilder) -> Path

UnixPath

source

pub struct UnixPath {
  is_absolute : Bool
  directory : Directory[UnixPathComponent]
  file : File[UnixPathComponent]?
}

Posix 4.13 Pathname Resolution

impl Eq for UnixPath

impl Hash for UnixPath

impl Show for UnixPath

impl ToJson for UnixPath

UnixPath::is_absolute

source

#alias(is_root_path)
fn UnixPath::is_absolute(self : UnixPath) -> Bool

UnixPath::is_relative

source

fn UnixPath::is_relative(self : UnixPath) -> Bool

UnixPath::new

source

fn UnixPath::new(is_absolute? : Bool, directory~ : Directory[UnixPathComponent], file? : File[UnixPathComponent]) -> UnixPath

UnixPathComponent

source

type UnixPathComponent

impl IsString for UnixPathComponent

impl PlatformPath for UnixPathComponent

impl Eq for UnixPathComponent

impl Hash for UnixPathComponent

impl Show for UnixPathComponent

impl ToJson for UnixPathComponent

WinPath

source

pub struct WinPath {
  prefix : WinPrefix
  directory : Directory[WinPathComponent]
  file : File[WinPathComponent]?
}

Microsoft Naming a Volume Microsoft Naming Files, Paths, and Namespaces Microsoft Maximum Path Length Limitation

impl Eq for WinPath

impl Hash for WinPath

impl Show for WinPath

impl ToJson for WinPath

WinPath::is_absolute

source

fn WinPath::is_absolute(self : WinPath) -> Bool

WinPath::is_relative

source

fn WinPath::is_relative(self : WinPath) -> Bool

WinPath::is_root_path

source

fn WinPath::is_root_path(self : WinPath) -> Bool

WinPath::new

source

fn WinPath::new(prefix? : WinPrefix, directory~ : Directory[WinPathComponent], file? : File[WinPathComponent]) -> WinPath

WinPathComponent

source

type WinPathComponent

impl IsString for WinPathComponent

impl PlatformPath for WinPathComponent

impl Eq for WinPathComponent

impl Hash for WinPathComponent

impl Show for WinPathComponent

impl ToJson for WinPathComponent

WinPrefix

source

pub(all) enum WinPrefix {
  Root
  VerbatimSymlink(String)
  VerbatimUNC(String, String)
  VerbatimVolumeLetter(Char)
  VerbatimVolumeGUID(String)
  DeviceNS(String)
  UNC(String, String)
  VolumeLetter(Char)
  None
}

Verbatim Prefix

refer to Microsoft Win32 File Namespaces

For file I/O, the "\?" prefix to a path string tells the Windows APIs to disable all string parsing and to send the string that follows it straight to the file system.

Windows Encoding

refer to Microsoft Path Unicode Normalization

There is no need to perform any Unicode normalization on path and file name strings for use by the Windows file I/O API functions because the file system treats path and file names as an opaque sequence of WCHARs. Any normalization that your application requires should be performed with this in mind, external of any calls to related Windows file I/O API functions.

Relative Paths Cannot use Verbatim Prefix

refer to Microsoft Verbatim restriction

Because you cannot use the "\?" prefix with a relative path, relative paths are always limited to a total of MAX_PATH characters.

impl Eq for WinPrefix

impl Hash for WinPrefix

impl Show for WinPrefix

impl ToJson for WinPrefix

Source Files

Site source Report issue Packages Build queue Skills Statistics

path

#illusory0x0/path

#Examples

#PathBuilder Usage

#Simple Usage

#Type Safe Operations

#Path Kinds Examples

#illusory0x0/path

#Examples

#PathBuilder Usage

#Simple Usage

#Type Safe Operations

#Path Kinds Examples

#UnixDirectory

#UnixFile

#WinDirectory

#WinFile

#IsString

#PlatformPath

#PathError

#Directory

#Directory::iter

#Directory::length

#Directory::new

#Directory::op_get

#Directory::sub

#File

#File::extension

#File::new

#Path

#Path::directory

#Path::file

#Path::is_absolute

#Path::is_relative

#Path::is_root_path

#Path::parse

#Path::prefix

#PathBuilder

#PathBuilder::add_directory

#PathBuilder::from_path

#PathBuilder::set_basename

#PathBuilder::set_extension

#PathBuilder::set_file

#PathBuilder::to_path

#UnixPath

#UnixPath::is_absolute

#UnixPath::is_relative

#UnixPath::new

#UnixPathComponent

#WinPath

#WinPath::is_absolute

#WinPath::is_relative

#WinPath::is_root_path

#WinPath::new

#WinPathComponent

#WinPrefix

Source Files

UnixDirectory

UnixFile

WinDirectory

WinFile

IsString

PlatformPath

PathError

Directory

Directory::iter

Directory::length

Directory::new

Directory::op_get

Directory::sub

File

File::extension

File::new

Path

Path::directory

Path::file

Path::is_absolute

Path::is_relative

Path::is_root_path

Path::parse

Path::prefix

PathBuilder

PathBuilder::add_directory

PathBuilder::from_path

PathBuilder::set_basename

PathBuilder::set_extension

PathBuilder::set_file

PathBuilder::to_path

UnixPath

UnixPath::is_absolute

UnixPath::is_relative

UnixPath::new

UnixPathComponent

WinPath

WinPath::is_absolute

WinPath::is_relative

WinPath::is_root_path

WinPath::new

WinPathComponent

WinPrefix