README.md

Ramstack.FileSystem.Physical

Provides an implementation of Ramstack.FileSystem based on local file system.

Getting Started

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

dotnet add package Ramstack.FileSystem.Physical

Usage

using Ramstack.FileSystem.Physical;

PhysicalFileSystem fs = new PhysicalFileSystem(@"C:\path\to\directory");

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

You can also configure the file system to be read-only:

using Ramstack.FileSystem.Physical;

PhysicalFileSystem fs = new PhysicalFileSystem(@"C:\path\to\directory")
{
    IsReadOnly = true
};

Related Projects

• Ramstack.FileSystem.Abstractions - Provides a virtual file system abstraction.
• 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.Readonly - Provides a read-only wrapper for the underlying file system.
• 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.