README.md

Ramstack.FileSystem.Readonly

Provides an implementation of Ramstack.FileSystem that wraps the underlying file system, preventing any destructive operations.

Getting Started

To install the Ramstack.FileSystem.Readonly NuGet package in your project, run the following command:

dotnet add package Ramstack.FileSystem.Readonly

Usage

using Ramstack.FileSystem.Readonly;

IVirtualFileSystem fileSystem = new PhysicalFileSystem(@"C:\path");
ReadonlyFileSystem fs = new ReadonlyFileSystem(fileSystem);

await foreach (VirtualFile file in fs.GetFilesAsync("/"))
{
    Console.WriteLine(node.Name);
}

// Throws an exception because the ReadonlyFileSystem does not support modifying operations
await fs.DeleteFileAsync("/hello.txt");

Related Projects

• Ramstack.FileSystem.Abstractions - Provides a virtual file system abstraction.
• Ramstack.FileSystem.Physical - Provides an implementation based on the local file system.
• Ramstack.FileSystem.Azure - Provides an implementation using Azure Blob storage.
• Ramstack.FileSystem.Amazon - Provides an implementation using Amazon S3 storage.
• Ramstack.FileSystem.Google - Provides an implementation using Google Cloud storage.
• Ramstack.FileSystem.Globbing - Wraps the file system, filtering files and directories using glob patterns.
• Ramstack.FileSystem.Prefixed - Adds a prefix to file paths within the underlying file system.
• Ramstack.FileSystem.Sub - Wraps the underlying file system, restricting access to a specific subpath.
• Ramstack.FileSystem.Adapters - Provides integration with Microsoft.Extensions.FileProviders.
• Ramstack.FileSystem.Composite - Provides an implementation that combines multiple file systems into a single composite file system.

Supported versions

	Version
.NET	6, 7, 8, 9, 10

Contributions

Bug reports and contributions are welcome.

License

This package is released as open source under the MIT License. See the LICENSE file for more details.