Lyo.IO.FileSystem
3.0.0
dotnet add package Lyo.IO.FileSystem --version 3.0.0
NuGet\Install-Package Lyo.IO.FileSystem -Version 3.0.0
<PackageReference Include="Lyo.IO.FileSystem" Version="3.0.0" />
<PackageVersion Include="Lyo.IO.FileSystem" Version="3.0.0" />
<PackageReference Include="Lyo.IO.FileSystem" />
paket add Lyo.IO.FileSystem --version 3.0.0
#r "nuget: Lyo.IO.FileSystem, 3.0.0"
#:package Lyo.IO.FileSystem@3.0.0
#addin nuget:?package=Lyo.IO.FileSystem&version=3.0.0
#tool nuget:?package=Lyo.IO.FileSystem&version=3.0.0
Lyo.IO.FileSystem
Path-rooted virtual file system. Callers use IFileSystem. LocalFileSystem and MemoryFileSystem ship in this package. SFTP, FTP, S3, Azure Blob, and FileSystemWatcher
implement the same contract in their existing packages. FileStorage uses IFileSystem only for physical keys (IFileStoragePhysical), not as a catalog. Paths stay under
RootPath through Lyo.Common.Core.Pathing.PathHelpers.
Features
- Contract.
IFileSystemlists, reads, writes, copies, and moves files, and resolves a relative path againstRootPath. Async is canonical; sync methods park (same pattern as Lyo SFTP/FTP clients). Missing paths throwFileNotFoundException, a refused overwrite throwsIOException, and an unsupported capability throwsNotSupportedExceptionon every backend. - Metadata in one call.
GetEntry/GetEntryAsyncreturn aFileSystemEntry?(kind, length, last write) instead of chainingFileExists,GetLength, andGetLastWriteTimeUtc.EnumerateDirectoryAsyncstreams a directory, optionally recursively, without materialising the listing. - Capabilities.
FileSystemCapabilitiesflags (Read,Write,CreateDirectory,Delete,Move,Copy,Watch,Append,MoveDirectory). Object stores clearAppendandMoveDirectory;Watchreturns null when watching is not supported. - Local disk.
LocalFileSystem(PathStyle.Host) jailed to a root directory, with one stat per metadata call, a single-pass directory listing, and async-capable streams from the async openers.CreateRootIfMissingcontrols whether the root is created on construction. - Memory.
MemoryFileSystem(PathStyle.Posix) on a flat path map plus a child index, guarded by aReaderWriterLockSlim. Point lookups stay O (1), listing is O (children) rather than O (store), and append, create, move, and subtree delete are atomic. Fits WASM and tests. - Helpers.
FileSystemExtensionsforReadAllBytes/ReadAllText,TouchFile,WriteAllBytes/WriteAllText/AppendAllText(includingReadOnlyMemory<byte>overloads),CopyStreamToFileAsync, andEnsureDirectoryAccessible.IFileTreeSourceis a list-only seam for tree UIs (including HTTP). - Shared contract suite.
Lyo.IO.FileSystem.TestsexposesIFileSystemContractTests, which every in-repo backend derives from so the sync and async halves of the interface are held to the same behaviour. - DI.
AddLocalFileSystem/AddMemoryFileSystem/AddLocalFileSystemFromConfiguration/AddFileTreeSource.
Examples
Local disk
services.AddLocalFileSystem(o => o.RootPath = "/var/lyo-data");
var fs = new LocalFileSystem("/tmp/lyo");
fs.CreateDirectory(Path.Combine(fs.RootPath, "reports"));
fs.WriteAllBytes(Path.Combine(fs.RootPath, "a.bin"), payload);
In-memory
services.AddMemoryFileSystem();
var fs = new MemoryFileSystem();
fs.WriteAllText("/note.txt", "hello");
if (await fs.GetEntryAsync("/note.txt", ct) is { IsDirectory: false } entry)
Console.WriteLine($"{entry.Length} bytes, written {entry.LastWriteTimeUtc:O}");
Dependencies
Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).
Lyo.Common.Core(direct, lyo)Lyo.Exceptions(direct, lyo)Microsoft.Bcl.AsyncInterfaces10.0.5(direct, microsoft, netstandard2.0)Microsoft.Extensions.Configuration.Binder10.0.5(direct, microsoft)Microsoft.Extensions.DependencyInjection.Abstractions10.0.5(direct, microsoft)System.Memory4.6.3(transitive, microsoft, netstandard2.0)System.Text.Json10.0.5(transitive, microsoft, netstandard2.0)
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Lyo.Common.Core (>= 3.0.0)
- Lyo.Exceptions (>= 3.0.0)
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.5)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
-
net10.0
- Lyo.Common.Core (>= 3.0.0)
- Lyo.Exceptions (>= 3.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on Lyo.IO.FileSystem:
| Package | Downloads |
|---|---|
|
Lyo.IO.Temp
Temp file and directory service with session tracking, logging, and metrics support. |
|
|
Lyo.FileStorage
File storage service interface and base implementation for file operations. |
|
|
Lyo.Ftp.Client
Thin FluentFTP client with connection pooling, PathHelpers jail, logging, and Lyo.Metrics. |
|
|
Lyo.Sftp.Client
Thin SSH.NET SFTP client with connection pooling, PathHelpers jail, logging, and Lyo.Metrics. |
|
|
Lyo.FileStorage.Web.Components
Reusable Blazor components for file storage: upload/save, path tree browser, DEK/KEK migration and rotation, metadata/expected-storage browser grids. |
GitHub repositories
This package is not used by any popular GitHub repositories.