Skip to content

Some API clean up from GPT 5.4 #1243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamhathcock merged 10 commits into from
Mar 10, 2026
Merged

Some API clean up from GPT 5.4 #1243

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f34ed8b
first commit for conslidating publci api
adamhathcock Mar 6, 2026
9050a7a
remove extra creates
adamhathcock Mar 6, 2026
bf32c85
Initial plan
Copilot Mar 6, 2026
b0e9736
Rename IWriteableArchiveFactory.cs to IWritableArchiveFactory.cs to m…
Copilot Mar 6, 2026
542f71f
Merge pull request #1244 from adamhathcock/copilot/sub-pr-1243
adamhathcock Mar 6, 2026
15d6d3c
Merge remote-tracking branch 'origin/master' into adam/api-clean-up
adamhathcock Mar 6, 2026
ebd784c
code review changes
adamhathcock Mar 6, 2026
f13ab3a
FindFactoryAsync shouldn't be public
adamhathcock Mar 6, 2026
e6a179b
fmt
adamhathcock Mar 6, 2026
b05a16d
oops, wrong change made
adamhathcock Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions src/SharpCompress/Archives/ArchiveFactory.Async.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,20 @@ public static async ValueTask<IAsyncArchive> OpenAsyncArchive(
}

public static async ValueTask<IAsyncArchive> OpenAsyncArchive(
IEnumerable<FileInfo> fileInfos,
IReadOnlyList<FileInfo> fileInfos,
Comment thread
adamhathcock marked this conversation as resolved.
ReaderOptions? options = null,
CancellationToken cancellationToken = default
)
{
fileInfos.NotNull(nameof(fileInfos));
var filesArray = fileInfos.ToArray();
if (filesArray.Length == 0)
var filesArray = fileInfos;
if (filesArray.Count == 0)
{
throw new ArchiveOperationException("No files to open");
}

var fileInfo = filesArray[0];
if (filesArray.Length == 1)
if (filesArray.Count == 1)
{
return await OpenAsyncArchive(fileInfo, options, cancellationToken)
.ConfigureAwait(false);
Expand All @@ -83,21 +83,21 @@ public static async ValueTask<IAsyncArchive> OpenAsyncArchive(
}

public static async ValueTask<IAsyncArchive> OpenAsyncArchive(
IEnumerable<Stream> streams,
IReadOnlyList<Stream> streams,
ReaderOptions? options = null,
CancellationToken cancellationToken = default
)
{
cancellationToken.ThrowIfCancellationRequested();
streams.NotNull(nameof(streams));
var streamsArray = streams.ToArray();
if (streamsArray.Length == 0)
var streamsArray = streams;
if (streamsArray.Count == 0)
{
throw new ArchiveOperationException("No streams");
}

var firstStream = streamsArray[0];
if (streamsArray.Length == 1)
if (streamsArray.Count == 1)
{
return await OpenAsyncArchive(firstStream, options, cancellationToken)
.ConfigureAwait(false);
Expand All @@ -114,18 +114,18 @@ public static async ValueTask<IAsyncArchive> OpenAsyncArchive(
}

public static ValueTask<T> FindFactoryAsync<T>(
string path,
string filePath,
CancellationToken cancellationToken = default
)
where T : IFactory
{
path.NotNullOrEmpty(nameof(path));
return FindFactoryAsync<T>(new FileInfo(path), cancellationToken);
filePath.NotNullOrEmpty(nameof(filePath));
return FindFactoryAsync<T>(new FileInfo(filePath), cancellationToken);
}

private static async ValueTask<T> FindFactoryAsync<T>(
public static async ValueTask<T> FindFactoryAsync<T>(
FileInfo finfo,
Comment thread
adamhathcock marked this conversation as resolved.
CancellationToken cancellationToken
CancellationToken cancellationToken = default
)
where T : IFactory
{
Expand All @@ -134,9 +134,9 @@ CancellationToken cancellationToken
return await FindFactoryAsync<T>(stream, cancellationToken).ConfigureAwait(false);
}

private static async ValueTask<T> FindFactoryAsync<T>(
public static async ValueTask<T> FindFactoryAsync<T>(
Stream stream,
CancellationToken cancellationToken
CancellationToken cancellationToken = default
)
where T : IFactory
{
Expand Down
66 changes: 54 additions & 12 deletions src/SharpCompress/Archives/ArchiveFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SharpCompress.Common;
using SharpCompress.Common.Options;
using SharpCompress.Factories;
Expand All @@ -21,7 +23,7 @@ public static IWritableArchive<TOptions> CreateArchive<TOptions>()
where TOptions : IWriterOptions
{
var factory = Factory
.Factories.OfType<IWriteableArchiveFactory<TOptions>>()
.Factories.OfType<IWritableArchiveFactory<TOptions>>()
.FirstOrDefault();

if (factory != null)
Expand All @@ -46,19 +48,19 @@ public static IArchive OpenArchive(FileInfo fileInfo, ReaderOptions? options = n
}

public static IArchive OpenArchive(
IEnumerable<FileInfo> fileInfos,
IReadOnlyList<FileInfo> fileInfos,
ReaderOptions? options = null
Comment thread
adamhathcock marked this conversation as resolved.
)
{
fileInfos.NotNull(nameof(fileInfos));
var filesArray = fileInfos.ToArray();
if (filesArray.Length == 0)
var filesArray = fileInfos;
if (filesArray.Count == 0)
{
throw new ArchiveOperationException("No files to open");
}

var fileInfo = filesArray[0];
if (filesArray.Length == 1)
if (filesArray.Count == 1)
{
return OpenArchive(fileInfo, options);
}
Expand All @@ -69,17 +71,17 @@ public static IArchive OpenArchive(
return FindFactory<IMultiArchiveFactory>(fileInfo).OpenArchive(filesArray, options);
}

public static IArchive OpenArchive(IEnumerable<Stream> streams, ReaderOptions? options = null)
public static IArchive OpenArchive(IReadOnlyList<Stream> streams, ReaderOptions? options = null)
{
Comment thread
adamhathcock marked this conversation as resolved.
streams.NotNull(nameof(streams));
var streamsArray = streams.ToArray();
if (streamsArray.Length == 0)
var streamsArray = streams;
if (streamsArray.Count == 0)
{
throw new ArchiveOperationException("No streams");
}

var firstStream = streamsArray[0];
if (streamsArray.Length == 1)
if (streamsArray.Count == 1)
{
return OpenArchive(firstStream, options);
}
Expand All @@ -100,11 +102,11 @@ public static void WriteToDirectory(
archive.WriteToDirectory(destinationDirectory, options);
}

public static T FindFactory<T>(string path)
public static T FindFactory<T>(string filePath)
where T : IFactory
{
path.NotNullOrEmpty(nameof(path));
using Stream stream = File.OpenRead(path);
filePath.NotNullOrEmpty(nameof(filePath));
using Stream stream = File.OpenRead(filePath);
return FindFactory<T>(stream);
}

Expand Down Expand Up @@ -182,6 +184,46 @@ public static bool IsArchive(Stream stream, out ArchiveType? type)
return false;
}

public static async ValueTask<(bool IsArchive, ArchiveType? Type)> IsArchiveAsync(
string filePath,
CancellationToken cancellationToken = default
)
{
filePath.NotNullOrEmpty(nameof(filePath));
using Stream stream = File.OpenRead(filePath);
return await IsArchiveAsync(stream, cancellationToken).ConfigureAwait(false);
}

public static async ValueTask<(bool IsArchive, ArchiveType? Type)> IsArchiveAsync(
Stream stream,
CancellationToken cancellationToken = default
)
{
stream.NotNull(nameof(stream));

if (!stream.CanRead || !stream.CanSeek)
{
throw new ArgumentException("Stream should be readable and seekable");
}

var startPosition = stream.Position;

foreach (var factory in Factory.Factories)
{
var isArchive = await factory
.IsArchiveAsync(stream, cancellationToken: cancellationToken)
.ConfigureAwait(false);
stream.Position = startPosition;

if (isArchive)
{
return (true, factory.KnownArchiveType);
}
}

return (false, null);
}

public static IEnumerable<string> GetFileParts(string part1)
{
part1.NotNullOrEmpty(nameof(part1));
Expand Down
28 changes: 14 additions & 14 deletions src/SharpCompress/Archives/GZip/GZipArchive.Factory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ public partial class GZipArchive
#endif
{
public static ValueTask<IWritableAsyncArchive<GZipWriterOptions>> OpenAsyncArchive(
string path,
string filePath,
ReaderOptions? readerOptions = null,
CancellationToken cancellationToken = default
)
{
cancellationToken.ThrowIfCancellationRequested();
path.NotNullOrEmpty(nameof(path));
return OpenAsyncArchive(new FileInfo(path), readerOptions, cancellationToken);
filePath.NotNullOrEmpty(nameof(filePath));
return OpenAsyncArchive(new FileInfo(filePath), readerOptions, cancellationToken);
}

public static IWritableArchive<GZipWriterOptions> OpenArchive(
Expand All @@ -37,7 +37,7 @@ public static IWritableArchive<GZipWriterOptions> OpenArchive(
)
{
filePath.NotNullOrEmpty(nameof(filePath));
return OpenArchive(new FileInfo(filePath), readerOptions ?? new ReaderOptions());
return OpenArchive(new FileInfo(filePath), readerOptions ?? ReaderOptions.ForFilePath);
}

public static IWritableArchive<GZipWriterOptions> OpenArchive(
Expand All @@ -50,39 +50,39 @@ public static IWritableArchive<GZipWriterOptions> OpenArchive(
new SourceStream(
fileInfo,
i => ArchiveVolumeFactory.GetFilePart(i, fileInfo),
readerOptions ?? new ReaderOptions()
readerOptions ?? ReaderOptions.ForFilePath
)
);
}

public static IWritableArchive<GZipWriterOptions> OpenArchive(
IEnumerable<FileInfo> fileInfos,
IReadOnlyList<FileInfo> fileInfos,
ReaderOptions? readerOptions = null
)
{
fileInfos.NotNull(nameof(fileInfos));
var files = fileInfos.ToArray();
var files = fileInfos;
return new GZipArchive(
new SourceStream(
files[0],
i => i < files.Length ? files[i] : null,
readerOptions ?? new ReaderOptions()
i => i < files.Count ? files[i] : null,
readerOptions ?? ReaderOptions.ForFilePath
)
);
}

public static IWritableArchive<GZipWriterOptions> OpenArchive(
IEnumerable<Stream> streams,
IReadOnlyList<Stream> streams,
ReaderOptions? readerOptions = null
)
{
streams.NotNull(nameof(streams));
var strms = streams.ToArray();
var strms = streams;
return new GZipArchive(
new SourceStream(
strms[0],
i => i < strms.Length ? strms[i] : null,
readerOptions ?? new ReaderOptions()
i => i < strms.Count ? strms[i] : null,
readerOptions ?? ReaderOptions.ForExternalStream
)
);
}
Expand All @@ -100,7 +100,7 @@ public static IWritableArchive<GZipWriterOptions> OpenArchive(
}

return new GZipArchive(
new SourceStream(stream, _ => null, readerOptions ?? new ReaderOptions())
new SourceStream(stream, _ => null, readerOptions ?? ReaderOptions.ForExternalStream)
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/SharpCompress/Archives/IArchiveOpenable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public static abstract TSync OpenArchive(
public static abstract TSync OpenArchive(Stream stream, ReaderOptions? readerOptions = null);

public static abstract ValueTask<TASync> OpenAsyncArchive(
string path,
string filePath,
ReaderOptions? readerOptions = null,
CancellationToken cancellationToken = default
);
Expand Down
4 changes: 2 additions & 2 deletions src/SharpCompress/Archives/IMultiArchiveOpenable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ public interface IMultiArchiveOpenable<TSync, TASync>
where TASync : IAsyncArchive
{
public static abstract TSync OpenArchive(
IEnumerable<FileInfo> fileInfos,
IReadOnlyList<FileInfo> fileInfos,
ReaderOptions? readerOptions = null
);

public static abstract TSync OpenArchive(
IEnumerable<Stream> streams,
IReadOnlyList<Stream> streams,
ReaderOptions? readerOptions = null
);

Expand Down
2 changes: 1 addition & 1 deletion src/SharpCompress/Archives/IWritableArchiveExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public void AddAllFromDirectory(
var path in Directory.EnumerateFiles(filePath, searchPattern, searchOption)
)
{
var fileInfo = new FileInfo(path);
var fileInfo = new FileInfo(filePath);
Comment thread
adamhathcock marked this conversation as resolved.
writableArchive.AddEntry(
path.Substring(filePath.Length),
fileInfo.OpenRead(),
Expand Down
2 changes: 1 addition & 1 deletion src/SharpCompress/Archives/IWritableAsyncArchiveExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public async ValueTask AddAllFromDirectoryAsync(
var path in Directory.EnumerateFiles(filePath, searchPattern, searchOption)
)
{
var fileInfo = new FileInfo(path);
var fileInfo = new FileInfo(filePath);
Comment thread
adamhathcock marked this conversation as resolved.
await writableArchive
.AddEntryAsync(
path.Substring(filePath.Length),
Expand Down
5 changes: 3 additions & 2 deletions src/SharpCompress/Archives/IWriteableArchiveFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace SharpCompress.Archives;

/// <summary>
/// Decorator for <see cref="Factories.Factory"/> used to declare an archive format as able to create writeable archives
/// Decorator for <see cref="Factories.Factory"/> used to declare an archive format as able to create writable archives.
/// </summary>
/// <remarks>
/// Implemented by:<br/>
Expand All @@ -12,7 +12,8 @@ namespace SharpCompress.Archives;
/// <item><see cref="Factories.ZipFactory"/></item>
/// <item><see cref="Factories.GZipFactory"/></item>
/// </list>
public interface IWriteableArchiveFactory<TOptions> : Factories.IFactory
/// </remarks>
public interface IWritableArchiveFactory<TOptions> : Factories.IFactory
where TOptions : IWriterOptions
{
/// <summary>
Expand Down
Loading
Loading