👁 Image
Oakrey.Applications.Files.Abstractions 6.0.0

Oakrey.Applications.Files.Abstractions

A .NET 10 library that defines the IFileService abstraction for file and directory operations. It contains no implementation code and carries no runtime dependencies, making it the correct reference for libraries and application layers that need file access without coupling to a concrete implementation.

Main features

Architecture

classDiagram
 class IFileService {
 +CreateFolder(folderName)
 +CreateSaveStream(fileName) FileStream
 +DeleteFile(fileName)
 +DeleteFileOlderThan(path, timeSpan, extension, ct) Task
 +GetFilesPaths(folder, extension) string[]
 +LoadFile(fileName) string
 +LoadFileAsync(fileName, ct) Task~string~
 +LoadFileStream(fileName) FileStream
 +SaveFile(fileName, value)
 }

 class FileService {
 <<Oakrey.Applications.Files>>
 }

 IFileService <|.. FileService

The concrete implementation lives in the separate Oakrey.Applications.Files package. Consuming projects should reference only this abstractions package and register the implementation via the extension provided by Oakrey.Applications.Files.

Requirements

• .NET 10 or later

Installation

dotnet add package Oakrey.Applications.Files.Abstractions

To also include the concrete implementation:

dotnet add package Oakrey.Applications.Files

Example usage

Registering the service

// In your composition root, reference Oakrey.Applications.Files for the extension method.
services.AddFilesService();

Consuming the abstraction

public sealed class ReportExporter
{
 private readonly IFileService _fileService;

 public ReportExporter(IFileService fileService)
 {
 _fileService = fileService;
 }

 public async Task ExportAsync(string path, string content, CancellationToken cancellationToken)
 {
 _fileService.CreateFolder(System.IO.Path.GetDirectoryName(path)!);
 _fileService.SaveFile(path, content);
 }

 public async Task<string> LoadAsync(string path, CancellationToken cancellationToken)
 {
 return await _fileService.LoadFileAsync(path, cancellationToken);
 }
}

Age-based cleanup

await _fileService.DeleteFileOlderThan(
 path: @"C:\Logs",
 timeSpan: TimeSpan.FromDays(30),
 extensionWithoutDot: "log",
 cancellationToken: cancellationToken);

Development notes

• This package contains only the IFileService interface. No implementation, logging, or telemetry code is included.
• The concrete implementation (FileService) is in Oakrey.Applications.Files and adds thread-safe async access via SemaphoreSlim, structured logging via Oakrey.Log, and OpenTelemetry activity spans via Oakrey.Telemetry.
• Both packages share the Oakrey.Applications.Files root namespace.

License

MIT � Copyright � Oakrey 2016-present