.NET 6.0 .NET Standard 2.0 .NET Framework 4.0
Install-Package Zio -Version 0.15.0
dotnet add package Zio --version 0.15.0
<PackageReference Include="Zio" Version="0.15.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Zio --version 0.15.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Zio, 0.15.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Zio as a Cake Addin
#addin nuget:?package=Zio&version=0.15.0

// Install Zio as a Cake Tool
#tool nuget:?package=Zio&version=0.15.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Zio Build Status Coverage Status NuGet

<img align="right" width="160px" height="160px" src="https://raw.githubusercontent.com/xoofx/zio/main/img/zio.png">

Zio provides a simple, powerful, cross-platform filesystem abstraction for .NET with many built-ins filesystems.

Features

  • Compatible with .NET 4.0, 4.5+, netstandard2.0, netstandard2.1 and net6.0
  • API providing all operations provided by the regular System.IO API (e.g File.Move, Directory.Delete... etc.)
    • Allowing atomic filesystem operations (e.g File.Replace...)
  • A simple interface abstraction IFileSystem
  • Supports for filesystem watcher through the IFileSystem.Watch method and the IFileSystemWatcher interface
    • For all builtin filesystems (aggregates, memory...etc.)
  • All paths are normalized through a lightweight uniform path struct UPath
  • Multiple built-ins filesystems:
    • PhysicalFileSystem to access the physical disks, directories and folders.
      • With uniform paths, this filesystem on Windows is working like on a Windows Subsystem Linux (WSL), by remapping drives to mount directory (e.g path /mnt/c/Windows equivalent to C:\Windows)
    • MemoryFileSystem to access a filesystem in memory:
      • Trying to be 100% compatible with a true PhysicalFileSystem (including exceptions)
      • Efficient concurrency with a per node (file or directory) locking mechanism
      • A safe hierarchical locking strategy (following Unix kernel recommendations for directory locking)
      • Support for FileShare.Read, FileShare.Write and FileShare.ReadWrite
      • Internally support for filesystem atomic operations (File.Replace)
    • ZipArchiveFileSystem to access zip archives:
      • This filesystem is a wrapper around the ZipArchive class
      • It can work in case sensitive and case insensitive mode
      • Support for FileShare.Read with ZipArchiveMode.Read
    • On top of these final filesystem, you can compose more complex filesystems:
      • AggregateFileSystem providing a read-only filesystem aggregating multiple filesystem that offers a merged view
      • MountFileSystem to mount different filesystems at a specific mount point name
      • SubFileSystem to view a sub-folder of another filesystem as if it was a root / directory
      • ReadOnlyFileSystem to interact safely with another filesystem in read-only mode
  • Higher level API similar to FileSystemEntry, FileEntry and DirectoryEntry offering a similar API to their respective FileSystemInfo, FileInfo, DirectoryInfo

Usage

Accessing a physical filesystem:

var fs = new PhysicalFileSystem();
foreach(var dir in fs.EnumerateDirectories("/mnt/c"))
{
    // ...
}

Using an in-memory filesystem:

var fs = new MemoryFileSystem();
fs.WriteAllText("/temp.txt", "This is a content");
if (fs.FileExists("/temp.txt"))
{
    Console.WriteLine("The content of the file:" + fs.ReadAllText("/temp.txt"))
}

The following documentation provides more information about the API and how to use it.

Documentation

The documentation is directly available as part of this repository in the /doc folder.

Download

Zio is available as a NuGet package: NuGet

Build

In order to build Zio, you need to install Visual Studio 2022 with latest .NET 6.0

License

This software is released under the BSD-Clause 2 license.

Credits

The logo is File by jeff from the Noun Project

Author

Alexandre MUTEL aka xoofx

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net40 net403 net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on Zio:

Package Downloads
Libplanet

A .NET library for creating multiplayer online game in decentralized fashion. See also the docs for details: https://docs.libplanet.io/

com.csutil.cscore

cscore is a lightweight library providing commonly used helpers and patterns for all your C# projects including Logging, PubSub and Injection. See more details at https://github.com/cs-util-com/cscore

Borg.Transporter.Core

Common code for the Transporter client.

CppAst.CodeGen

CppAst.CodeGen is an extensible P/Invoke Code Generator from C++ to C# for .NET

Test262Harness

Test262 Harness for .NET

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Zio:

Repository Stars
planetarium/libplanet
Blockchain toolkit in C#/.NET for decentralized game
SnowflakePowered/snowflake
:snowflake: :video_game: Emulator Frontend and SDK
cs-util-com/cscore
cscore is a minimal-footprint library providing commonly used helpers & patterns for your C# projects. It can be used in both pure C# and Unity projects.
Version Downloads Last updated
0.15.0 3,307 4/24/2022
0.14.0 2,989 2/4/2022
0.13.0 14,404 8/31/2021
0.12.0 2,322 5/31/2021
0.11.0 8,615 12/24/2020
0.10.0 300 12/23/2020
0.9.1 46,830 6/18/2020
0.9.0 485 6/17/2020
0.8.0 60,928 4/19/2020
0.7.6 43,332 1/28/2020
0.7.5 371 1/28/2020
0.7.4 194,865 5/11/2019
0.7.3 2,402 2/6/2019
0.7.2 3,827 4/4/2018
0.7.1 4,377 1/12/2018
0.7.0 803 1/11/2018
0.6.0 1,016 12/23/2017
0.5.0 879 12/10/2017
0.4.0 860 12/9/2017
0.3.6 1,050 11/19/2017
0.3.5 878 11/19/2017
0.3.4 877 11/19/2017
0.3.3 899 11/19/2017
0.3.2 882 11/14/2017
0.3.1 826 5/15/2017
0.3.0 732 5/14/2017
0.2.0 795 5/5/2017
0.1.0 762 5/1/2017