Oakrey.Readers 1.0.0

dotnet add package Oakrey.Readers --version 1.0.0
                    
NuGet\Install-Package Oakrey.Readers -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Oakrey.Readers" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oakrey.Readers" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Oakrey.Readers" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Oakrey.Readers --version 1.0.0
                    
#r "nuget: Oakrey.Readers, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Oakrey.Readers@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Oakrey.Readers&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Oakrey.Readers&version=1.0.0
                    
Install as a Cake Tool

Oakrey.Readers

Overview

The "Readers" project provides a framework for reading and processing lines from text files. It is designed to handle various line formats and structures, making it suitable for applications requiring structured file parsing.

Features

Line Reading:

LineReader<TLine>: A generic class for reading lines from a file and converting them into instances of a specified line type (TLine).

Line Interfaces:

  • ILine: Base interface for representing a line.
  • IComponentLine and IEscapeLine: Specialized interfaces for handling component-based and escape-character-based lines.

Line Implementations:

  • Line: Represents a basic line structure.
  • ComponentLine and EscapeLine: Handle lines with specific formats, such as delimited components or escape sequences.

File Parsing:

Supports reading lines sequentially, skipping empty lines, and resetting the reader to the beginning of the file.

Extensibility:

The framework is designed to be extended with custom line types and parsing logic.

Error Handling:

Provides detailed exceptions for scenarios like empty lines where data is expected.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Readers and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Readers

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Readers

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Oakrey.Readers:

Package Downloads
Oakrey.LDF

Parser and model for LIN Description Files (LDF), enabling structured access to LIN protocol data, including nodes, signals, frames, and schedules.

Oakrey.DBC

The DBC library is a .NET 8 framework for parsing, managing, and exporting DBC files. It provides tools for handling CAN database elements such as messages, signals, nodes, and attributes. Designed for extensibility and performance, it is ideal for automotive, industrial, and IoT applications requiring DBC file management.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 262 4/16/2025