Skip to content

Commit be4b6bc

Browse files
committed
Mark ZipFileSystem as obsolete
1 parent c758f2b commit be4b6bc

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/Ramstack.FileSystem.Zip/ZipFileSystem.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ namespace Ramstack.FileSystem.Zip;
77
/// <summary>
88
/// Represents a file system backed by a ZIP archive.
99
/// </summary>
10+
/// <remarks>
11+
/// <b>WARNING:</b>
12+
/// <para>
13+
/// The <see cref="ZipFileSystem"/> is not thread-safe and allows reading only one file at a time, as it relies on
14+
/// <see cref="ZipArchive"/>, which does not support parallel read operations or simultaneous opening of multiple streams.
15+
/// </para>
16+
/// <para>
17+
/// You may use this class only if you can guarantee that:
18+
/// <list type="bullet">
19+
/// <item><description>Only one file is open for reading at a time.</description></item>
20+
/// <item><description>No file is accessed concurrently.</description></item>
21+
/// </list>
22+
/// </para>
23+
/// </remarks>
24+
[Obsolete("Deprecated due to thread safety limitations and parallel file access capabilities.")]
1025
public sealed class ZipFileSystem : IVirtualFileSystem
1126
{
1227
private readonly ZipArchive _archive;

0 commit comments

Comments
 (0)