Summary

This proposal suggests modifying the AddFile method signature in the DiscUtils project to accept a Func<Stream> instead of a direct Stream. This change aims to optimize resource management and the method's flexibility, especially in scenarios where the Build method finalizes data writing.

Detail

Currently, the AddFile method accepts a Stream parameter directly, implying that the data stream must be available and open at the call time, regardless of when the writing actually occurs (via the Build method). This approach can lead to resource management issues, such as streams being prematurely closed or locked due to their use in other processes before the execution of Build.

The proposal is to change the AddFile method signature to accept a Func<Stream>. This would allow:

• Postponing the creation and opening of the Stream until just before its use, ensuring its availability and optimal condition.
• Improving the management of the Stream lifecycle, aligning with reactive and functional programming principles.
• Offering a more robust and flexible solution for file manipulation in complex scenarios.

Previous Usage Example

stream = new FileStream(path, FileMode.Open);
someFsBuilder.AddFile("example/path", stream);
// The stream needs to be kept open and managed externally until Build

Proposed Usage Example

someFsBuilder.AddFile("example/path", () => new FileStream(path, FileMode.Open));
// The stream is created and opened internally at the optimal moment, simplifying its management

Advantages

• Resource Management: Avoids the need to keep streams unnecessarily open or to manage their lifecycle externally.
• Flexibility: Provides greater flexibility in file management, especially in applications that work with a large amount of data or that require fine control over file manipulation.
• Robustness: Reduces the risk of runtime errors related to stream handling, such as attempting to write to an already closed stream.

I appreciate your consideration of this proposal and are open to discussing any related aspects. I believe this improvement can significantly add value to DiscUtils project.

Thanks!