SabreTools/SabreTools.IO
1
0
Fork 0
mirror of https://github.com/SabreTools/SabreTools.IO.git synced 2026-07-08 17:57:02 +00:00
Code Issues 1 Packages Projects Releases 20 Wiki Activity

Separate out main IO classes in README

Browse Source
This commit is contained in:
Matt Nadareski
2026-03-18 15:30:13 -04:00
parent 61808f82f6
commit c689bae4c2
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.MD
View File

@@ -14,18 +14,23 @@ Below are a list of the included namespaces and their overall utility.
Generic helper classes that involve custom functionality and utility.
#### Classes
#### Stream Implementations
| Class | Notes |
| --- | --- |
| `BufferedStream` | Not a true stream implementation used for buffered, single-byte reads |
| `ParentablePath` | Class that represents a path that is rooted by a parent directory |
| `PathTool` | Utility class for common Path-related functions |
| `ReadOnlyBitStream` | Read-only stream implementation allowing bitwise reading |
| `ReadOnlyCompositeStream` | Read-only stream implementation that wraps multiple source streams in a set order |
| `Transform` | Utility class that allows common data transformations for streams and byte arrays |
| `ViewStream` | Read-only stream implementation representing a view into source data |
#### Utility Classes
| Class | Notes |
| --- | --- |
| `ParentablePath` | Class that represents a path that is rooted by a parent directory |
| `PathTool` | Utility class for common Path-related functions |
| `Transform` | Utility class that allows common data transformations for streams and byte arrays |
`Transform` functionality includes:
- Combine using either ordered concatenation or interleaving