Olve.Paths 0.38.0

Olve.Paths

A .NET library for working with file and directory paths inspired by Python's pathlib module. It provides an object-oriented interface for manipulating paths in a more intuitive way than raw strings.

Installation

dotnet add package Olve.Paths

Overview

Usage

Path navigation

Create a path with Path.Create() and navigate using Parent, Name, and the / operator for joining.

// ../../tests/Olve.Paths.Tests/ReadmeDemo.cs#L8-L14

var path = Path.Create("/home/user/documents"); // /home/user/documents

var parent = path.Parent; // /home/user
var folderName = path.Name; // documents

var newPath = path / "newfile.txt"; // /home/user/documents/newfile.txt
var exists = newPath.Exists(); // Check if the file exists

On Windows the same API applies with backslash-separated paths:

// ../../tests/Olve.Paths.Tests/ReadmeDemo.cs#L28-L34

var path = Path.Create(@"C:\users\user\documents"); // C:\users\user\documents

var parent = path.Parent; // C:\users\user
var folderName = path.Name; // documents

var newPath = path / "newfile.txt"; // C:\users\user\documents\newfile.txt
var exists = newPath.Exists(); // Check if the file exists

Pure paths

Path.CreatePure() creates immutable paths that work on any platform without touching the filesystem. Pass a PathPlatform to create paths for a specific platform regardless of the host OS.

// ../../tests/Olve.Paths.Tests/ReadmeDemo.cs#L48-L53

// Pure paths allow platform-independent path manipulation
var unixPath = Path.CreatePure("/home/user/docs", PathPlatform.Unix);
var windowsPath = Path.CreatePure(@"C:\users\user\docs", PathPlatform.Windows);

var unixPlatform = unixPath.Platform; // PathPlatform.Unix
var windowsPlatform = windowsPath.Platform; // PathPlatform.Windows

Filesystem operations

IPath provides methods for querying and manipulating the filesystem: Exists(), ElementType, TryGetChildren(), and EnsurePathExists().

// ../../tests/Olve.Paths.Tests/ReadmeDemo.cs#L65-L76

// Filesystem operations
var tempDir = Path.CreateTempDirectory("olve-paths-demo-"); // Creates a unique temp directory
var exists = tempDir.Exists(); // true
var elementType = tempDir.ElementType; // ElementType.Directory

if (tempDir.TryGetChildren(out var children))
{
    foreach (var child in children)
    {
        Console.WriteLine(child.Path);
    }
}

Temporary paths

Path wraps .NET's temporary path APIs and returns IPath objects. GetTempDirectory() returns the system temp directory, CreateTempDirectory() creates a unique subdirectory, and CreateTempFile() creates a unique zero-byte file.

// ../../tests/Olve.Paths.Tests/ReadmeDemo.cs#L89-L92

// Temporary paths
var tempDir = Path.GetTempDirectory(); // System temp directory
var tempSubDir = Path.CreateTempDirectory("my-app-"); // Unique temp subdirectory
var tempFile = Path.CreateTempFile(); // Unique temp file

Globbing

See Olve.Paths.Glob for wildcard pattern matching on paths.

Documentation

Full API reference: https://olivervea.github.io/Olve.Utilities/api/Olve.Paths.html

License

MIT License © OliverVea