equadrat.Framework.FileProviders.Interfaces (8.3.0)
Installation
dotnet nuget add source --name equadrat-oss --username your_username --password your_token dotnet add package --source equadrat-oss --version 8.3.0 equadrat.Framework.FileProviders.InterfacesAbout this package
A framework to extend the Microsoft .net framework with extra file providers.
equadrat Framework File Providers
The idea of the equadrat Framework is to provide APIs to build applications with an architecture of highly decoupled components. Every single component, aspect or pattern is represented by interfaces. The framework provides a standard implementation for these but each type can be replaced by a custom implementation.
The framework is not about reimplementing components, but making them available using common interfaces.
Getting started
You can use most of the components by simply instantiating them. This is maybe the easiest way to evaluate the framework.
If you're using an IOC/DI container such as Microsoft Extensions DependencyInjection or if you want to use the built-in IOC framework, you can use the bootstrapper and bootstrapper modules to register the framework to the IOC.
Usage
public static void Main(string[] args)
{
var builder = Host.CreateApplicationBuilder(args);
// Use the module registry to register bootstrapper modules. Usually each assembly has its own bootstrapper module.
// This will add their service declarations to the IServiceCollection.
// This requires equadrat.Framework.Core.Microsoft.Extensions.Hosting NuGet package.
builder.Services.RegisterBootstrapperModules(moduleRegistry => moduleRegistry.FileProvidersFramework().RegisterBaseModule());
// Declare other services as usual.
// builder.Services.AddSingleton<...>(...);
var app = builder.Build();
// Optional: initialize all services declared by the registered bootstrapper modules. Calling this method is required for all environments which doesn't support IHostedService, such es browsers/webassembly.
app.Services.InitBootstrapperModules();
app.Run();
}
Have a look at the example applications on equadrat.net and in the wiki.
Interesting components
This is a list of some (not all) components of the framework which might be interesting for you.
Wrappers for standard file providers
- IExtPhysicalFileProviderFactory
- IExtFileProviderFactory
Extended File Providers
- IExtPhysicalFileProviderFactory
- IExtInMemoryFileProviderFactory
- IExtSmbFileProviderFactory
Working with multiple file providers
- IExtFileProviderRegistry
- IExtFileProviderResolver
Compatibility
The plan is to keep the equadrat Framework compatible to these .net versions as long as possible.
| .net version | min | max | automated tests* |
|---|---|---|---|
| Core | 3.1 | ≥ 10.x | yes |
| Standard | 2.0 | ≥ 2.1 | no |
| Framework | 4.6.2 | ≥ 4.8.x | no |
*The automated tests run under Linux for .net Core 6.x and above.
Version scheme and breaking changes
| Version change | Scope |
|---|---|
| Major | Overhaul of the project |
| Minor | Some types have changed |
| Revision | Fully backward compatible |
| Build | Set in preview versions only |
Additional documentation
You can find some guides regarding specific features on my website: www.equadrat.net
Feedback
You can contact me on my website: www.equadrat.net
License
Please respect the license and check equadrat.Framework.FileProviders.License.md before using the package.
Release notes
v8.3.0
- Removed .net Framework versions (v4.x) from target frameworks.
v8.2.0
- Added support for .net 10.
v8.1.0
- Compatibility release
v8.0.0
- Compatibility release
v7.6.0
- Updated NuGet package references.
v7.5.1
- Fixed bug in ExtS3FileSystemEntry.WriteAsync to pass-through the provided options.
- Added check when using ExtS3FileProvider.GetFileInfo with improper SSL mode to avoid irritating ArgumentOutOfRangeException related to DateTimeOffset.
v7.5.0
- Updated NuGet package references.
- Added file provider for SMB shares.
- Added file provider for S3 servers.
- Added file provider for FTP servers.
v7.4.0
- Initial Release