Oakrey.Files 2.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Oakrey.Files --version 2.0.0
                    
NuGet\Install-Package Oakrey.Files -Version 2.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.Files" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oakrey.Files" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Oakrey.Files" />
                    
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.Files --version 2.0.0
                    
#r "nuget: Oakrey.Files, 2.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.Files@2.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.Files&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Oakrey.Files&version=2.0.0
                    
Install as a Cake Tool

Oakrey.Files

1. Overview

The Files project provides utilities for file naming and compression. It simplifies the generation of unique file names based on various policies and offers methods for compressing and decompressing files and byte arrays.

2. Feature

File Naming Utilities:

FileNameGenerator:

  • Generates file names based on policies like date-time, GUID, incremental, and user-defined formats.
  • Supports creating file paths by combining folder paths, file names, and extensions.

FileNameSource:

  • Encapsulates file naming parameters and provides methods to generate file names and paths dynamically.

FileNamingPolicy:

  • Enum defining supported naming policies (e.g., DateTime, GUID, Incremental).

Compression and Decompression:

ZipCompression:

  • Provides methods to compress and decompress byte arrays and files using GZip.

Thread-Safe Operations:

Ensures thread safety for file name generation using locks.

Extensibility:

Designed to support additional file naming policies and compression algorithms.

3. 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.Files and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Files

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Files

4. Requirements

  • .NET 8 or higher

5. Project Information

6. Contributing

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

7. License

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

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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.
  • net10.0

    • No dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Oakrey.Files:

Package Downloads
Oakrey.Applications.CustomLogging

A flexible and extensible .NET library for custom logging, supporting multiple logging engines, log broadcasting, and contextual logging with file path customization.

Oakrey.Applications.Reporting

A .NET 10 library for structured, lifecycle-driven reporting. Defines IReporter and IReportConsumer generics with a TStatus enum, supporting report/block/item lifecycle events, evidence attachment, key-value metadata, and file output via FileReporter. RunnableReporter fans out to multiple consumers simultaneously.

Oakrey.Applications.Trace

A .NET library for tracing application activities to files. Provides ITracer with start/stop control, real-time status and elapsed-time observables (Rx), configurable file paths and naming policies, thread-safe file writing, and integration with Oakrey.Telemetry and Oakrey.Log.

Oakrey.Applications.FileParsing.Ini

Specialized file parsing library for INI configuration files. Built on FileParsing framework with automatic parsing, reactive updates, and file browsing integration. Features auto-load support, observable patterns, and seamless integration with Oakrey.Files INI reader.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.0.0 159 3/13/2026
2.1.0 152 1/20/2026
2.0.0 333 11/13/2025
1.1.0 233 10/30/2025
1.0.1 230 9/26/2025
1.0.0 370 4/16/2025