Path Type for Dart

path_type is a Dart package that introduces a robust Path type inspired by Rust's Path type. This package provides a way to work with file paths in a structured and type-safe manner, supporting POSIX and Windows file systems.

Features

Path Manipulation: Easily join, extend, and modify paths.
Component Extraction: Extract components like file name, extension, and parent directory.
File System Interaction: Query file system metadata, check existence, and more.
Cross-Platform Support: Separate implementations for POSIX and Windows paths, and runs on all platforms including web.
Zero Runtime Cost: Path is implemented as an extension type of String.

Usage

import

import 'package:path_type/posix.dart'; // or
import 'package:path_type/windows.dart'; // or
import 'package:path_type/platform.dart'; // or, uses posix unless on windows

Basic Operations

Create a path and perform basic operations:

import 'package:path_type/posix.dart';

void main() {
  var path = Path('/foo/bar/baz.txt');

  print('File name: ${path.fileName()}'); // Output: baz.txt
  print('Extension: ${path.extension()}'); // Output: txt
  print('Is absolute: ${path.isAbsolute()}'); // Output: true

  var parent = path.parent();
  if (parent.isSome()) {
    print('Parent: ${parent.unwrap()}'); // Output: /foo/bar
  }

  var newPath = path.withExtension('md');
  print('New path with extension: $newPath'); // Output: /foo/bar/baz.md
}

Extracting Components

Get the components of a path:

void main() {
  var path = Path('/foo/bar/baz.txt');
  var components = path.components().toList();

  for (var component in components) {
    print(component); // Output: /, foo, bar, baz.txt
  }
}

Ancestors

Retrieve all ancestors of a path:

void main() {
  var path = Path('/foo/bar/baz.txt');

  for (var ancestor in path.ancestors()) {
    print(ancestor);
    // Output:
    // /foo/bar/baz.txt
    // /foo/bar
    // /foo
    // /
  }
}

File System Interaction

Check if a path exists and get metadata:

void main() {
  var path = Path('/foo/bar/baz.txt');

  if (path.exists()) {
    var metadata = path.metadata();
    print('File size: ${metadata.size}');
    print('Last modified: ${metadata.modified}');
  } else {
    print('Path does not exist.');
  }
}