libpath 0.0.3

Path parsing library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

# libpath.Rust <!-- omit in toc -->

Path parsing library, for Rust

![Language](https://img.shields.io/badge/Rust-000000?style=flat&logo=rust&logoColor=white)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Crates.io](https://img.shields.io/crates/v/libpath.svg)](https://crates.io/crates/libpath)
[![GitHub release](https://img.shields.io/github/v/release/synesissoftware/libpath.Rust.svg)](https://github.com/synesissoftware/libpath.Rust/releases/latest)
![MSRV](https://img.shields.io/badge/MSRV-1.74-lightgrey)
[![CI](https://github.com/synesissoftware/libpath.Rust/actions/workflows/ci.yml/badge.svg)](https://github.com/synesissoftware/libpath.Rust/actions/workflows/ci.yml)
[![docs.rs](https://docs.rs/libpath/badge.svg)](https://docs.rs/libpath)


## Table of Contents <!-- omit in toc -->

- [Introduction](#introduction)
- [Installation](#installation)
- [Components](#components)
  - [Common result type](#common-result-type)
  - [Unix path classification](#unix-path-classification)
  - [Windows path classification](#windows-path-classification)
- [Examples](#examples)
- [Project Information](#project-information)
  - [Where to get help](#where-to-get-help)
  - [Contribution guidelines](#contribution-guidelines)
  - [Dependencies](#dependencies)
    - [Efferent (fan-out)](#efferent-fan-out)
      - [Runtime Dependencies](#runtime-dependencies)
      - [Build Dependencies](#build-dependencies)
      - [Development Dependencies](#development-dependencies)
    - [Afferent (fan-in)](#afferent-fan-in)
  - [Related projects](#related-projects)
  - [License](#license)


## Introduction

**libpath.Rust** is a small Rust library for classifying Unix-like and
Windows path syntax. It reports path components as positions into the
original input string, without accessing the file system.


## Installation

Reference **libpath** from **Cargo.toml**:

```toml
libpath = { version = "0.0.3" }
```

The repository retains **Cargo.lock** to make local and CI verification
reproducible. Release and validation commands use `--locked`.


## Components

### Common result type

`libpath::util::common::ClassificationResult` describes the positions of
the input, root, directory, entry name, stem, extension, and related path
parts. Its fields use `fastparse::fastparse::types::PositionalSlice`.


### Unix path classification

`libpath::util::unix::path_classify()` classifies Unix-like paths and
returns `libpath::util::unix::Classification` together with a
`ClassificationResult`. The module also defines the parsing flag constants
in `classification_flags`.


### Windows path classification

`libpath::util::windows::path_classify()` classifies paths using forward
or backward separators, drive-letter roots and relative drive paths, and
the currently implemented tilde-rooted form. It returns the Windows
`Classification` and a `ClassificationResult`.


## Examples

There are no maintained example programs yet. The `libver` binary is a
deliberately retained scratch utility that prints the package name and
version:

```text
cargo run --bin libver
```

It is a repository utility rather than an example of the public path API.


## Project Information

### Where to get help

[GitHub Page](https://github.com/synesissoftware/libpath.Rust "GitHub Page")


### Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on
https://github.com/synesissoftware/libpath.Rust.


### Dependencies

#### Efferent (fan-out)

Libraries upon which **libpath.Rust** depends:

##### Runtime Dependencies

* [**FastParse.Rust**](https://github.com/synesissoftware/FastParse.Rust) —
  provides the public `PositionalSlice` result type;


##### Build Dependencies

None.


##### Development Dependencies

* [**test_help-rs**](https://github.com/synesissoftware/test_help-rs) —
  declared for repository test support;


#### Afferent (fan-in)

No downstream consumers are currently recorded.


### Related projects

* [**libpath**](https://github.com/synesissoftware/libpath);
* [**libpath.Go**](https://github.com/synesissoftware/libpath.Go);
* [**libpath.Ruby**](https://github.com/synesissoftware/libpath.Ruby);
* [**recls.Rust**](https://github.com/synesissoftware/recls.Rust);


### License

**libpath.Rust** is released under the 3-clause BSD license. See
[LICENSE](./LICENSE) for details.


<!-- ########################### end of file ########################### -->