Skip to content

Docs: add information about TruePath.TestableIO.System.IO #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ForNeVeR merged 1 commit into from
Mar 7, 2026
Merged

Docs: add information about TruePath.TestableIO.System.IO #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,17 @@ If you miss some feature or have questions, do not hesitate to [open an issue][i

Packages
--------
| Name | NuGet Package | Documentation |
|-----------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------|
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] |
| Name | NuGet Package | Documentation |
|-----------------------|-------------------------------------------------------------------------------------------------|--------------------------------------------|
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] |
| **TruePath.TestableIO.System.IO** (third-party) | [![TruePath.TestableIO.System.IO on nuget.org][nuget.badge.true-path.testableio.system-io]][nuget.true-path.testableio.system-io] | [Documentation][github.true-path.testable-io] |

TruePath provides two NuGet packages:
- [**TruePath**][nuget.true-path] for the main path abstractions,
- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration.
- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration.

A third-party package, [**TruePath.TestableIO.System.IO**][nuget.true-path.testableio.system-io], adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath.

Documentation
-------------
Expand All @@ -55,12 +58,16 @@ The license indication in the project's sources is compliant with the [REUSE spe
[docs.true-path.system-io]: https://fornever.github.io/TruePath/api/TruePath.SystemIo.html
[docs.true-path]: https://fornever.github.io/TruePath/api/TruePath.html
[docs]: https://fornever.github.io/TruePath
[github.true-path.testable-io]: https://github.com/jeppevammenkristensen/FileBasedApp.Toolkit/blob/main/Source/TruePath.TestableIO.System.IO/README.md
[issues]: https://github.com/ForNeVeR/TruePath/issues
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
[nuget.badge.true-path.system-io]: https://img.shields.io/nuget/v/TruePath.SystemIo
[nuget.badge.true-path.testableio.system-io]: https://img.shields.io/nuget/v/TruePath.TestableIO.System.IO
[nuget.badge.true-path]: https://img.shields.io/nuget/v/TruePath
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
[nuget.true-path.testableio.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
[nuget.true-path]: https://www.nuget.org/packages/TruePath
[reuse.spec]: https://reuse.software/spec-3.3/
[status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg
[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions
4 changes: 4 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ TruePath provides two packages:
- [TruePath][nuget.true-path] for path abstractions,
- [TruePath.SystemIo][nuget.true-path.system-io] for the `System.IO` integration.

A third-party package, [TruePath.TestableIO.System.IO][nuget.true-path.testable-io.system-io], which adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath.

Usage
-----
The library offers several struct (i.e. low to zero memory overhead) types wrapping path strings. The types are designed to not involve any disk IO operations by default, and thus provide excellent performance during common operations. This comes with a drawback, though: **path comparison is only performed as string comparison so far** — though it tries to take platform-specific case sensitivity defaults into account. See the section **Path Comparison** for details.
Expand Down Expand Up @@ -120,4 +122,6 @@ To convert the path to the canonical form, use `AbsolutePath::Canonicalize`.
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
[nuget.true-path.testable-io.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
[nuget.true-path]: https://www.nuget.org/packages/TruePath
[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions