// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
#nullable enable
using System.IO;
using System.Threading;
using System.Threading.Tasks;
namespace Duplicati.Library.Utility;
///
/// A stream that wraps a temporary file.
/// The temporary file is automatically deleted when the stream is disposed.
///
public class TempFileStream : StreamUtil.WrappingAsyncStream
{
///
/// The temporary file instance.
///
private readonly TempFile tempFile;
///
/// The stream for the temporary file.
///
private readonly Stream stream;
///
/// The path to the temporary file.
///
public string Path => tempFile.Name;
///
/// Creates a new TempFileStream instance.
///
/// The temporary file instance.
/// The stream for the temporary file.
private TempFileStream(TempFile tempFile, Stream stream)
: base(stream)
{
this.tempFile = tempFile;
this.stream = stream;
}
///
/// Creates a new TempFileStream instance.
///
/// The temporary file instance.
/// The new TempFileStream instance.
public static TempFileStream Create(TempFile tempFile)
{
return new TempFileStream(tempFile, File.Open(tempFile.Name, FileMode.Open, FileAccess.ReadWrite, FileShare.None));
}
///
/// Creates a new TempFileStream instance.
///
/// The new TempFileStream instance.
public static TempFileStream Create()
{
var tempFile = new TempFile();
return new TempFileStream(tempFile, File.Open(tempFile.Name, FileMode.Open, FileAccess.ReadWrite, FileShare.None));
}
///
protected override Task ReadImplAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
=> stream.ReadAsync(buffer, offset, count, cancellationToken);
///
protected override Task WriteImplAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
=> stream.WriteAsync(buffer, offset, count, cancellationToken);
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
stream.Dispose();
tempFile.Dispose();
}
}