/// <summary>
/// Writes the specified <see cref="System.IO.Stream"/> to the response.
/// <para>
/// This supports range requests (<see cref="StatusCodes.Status206PartialContent"/> or
/// <see cref="StatusCodes.Status416RangeNotSatisfiable"/> if the range is not satisfiable).
/// </para>
/// <para>
/// This API is an alias for <see cref="Stream(Stream, string, string?, DateTimeOffset?, EntityTagHeaderValue?, bool)"/>.
/// </para>
/// </summary>
/// <param name="fileStream">The <see cref="System.IO.Stream"/> with the contents of the file.</param>
/// <param name="contentType">The Content-Type of the file.</param>
/// <param name="fileDownloadName">The the file name to be used in the <c>Content-Disposition</c> header.</param>
/// <param name="lastModified">The <see cref="DateTimeOffset"/> of when the file was last modified.
/// Used to configure the <c>Last-Modified</c> response header and perform conditional range requests.</param>
/// <param name="entityTag">The <see cref="EntityTagHeaderValue"/> to be configure the <c>ETag</c> response header
/// and perform conditional requests.</param>
/// <param name="enableRangeProcessing">Set to <c>true</c> to enable range requests processing.</param>
/// <returns>The created <see cref="IResult"/> for the response.</returns>
/// <remarks>
/// The <paramref name="fileStream" /> parameter is disposed after the response is sent.
/// </remarks>
#pragma warning disable RS0026 // Do not add multiple public overloads with optional parameters
public static IResult File(
#pragma warning restore RS0026 // Do not add multiple public overloads with optional parameters
Stream fileStream,
string?contentType = null,
string?fileDownloadName = null,
DateTimeOffset?lastModified = null,
EntityTagHeaderValue?entityTag = null,
bool enableRangeProcessing = false)
=> TypedResults.File(fileStream, contentType, fileDownloadName, lastModified, entityTag, enableRangeProcessing);
public void BytesOrFile_ResultHasCorrectValues(int bytesOrFile, string contentType, string fileDownloadName, bool enableRangeProcessing, DateTimeOffset lastModified, EntityTagHeaderValue entityTag)
{
// Arrange
var contents = new byte[0];
// Act
var result = bytesOrFile switch
{
0 => TypedResults.Bytes(contents, contentType, fileDownloadName, enableRangeProcessing, lastModified, entityTag),
_ => TypedResults.File(contents, contentType, fileDownloadName, enableRangeProcessing, lastModified, entityTag)
};
// Assert
Assert.Equal(contents, result.FileContents);
Assert.Equal(contentType ?? "application/octet-stream", result.ContentType);
Assert.Equal(fileDownloadName, result.FileDownloadName);
Assert.Equal(enableRangeProcessing, result.EnableRangeProcessing);
Assert.Equal(lastModified, result.LastModified);
Assert.Equal(entityTag, result.EntityTag);
}
public void File_WithNullStream_ThrowsArgNullException()
{
Assert.Throws <ArgumentNullException>("fileStream", () => TypedResults.File(default(Stream)));
}
public void File_WithNullContents_ThrowsArgNullException()
{
Assert.Throws <ArgumentNullException>("fileContents", () => TypedResults.File(default(byte[])));
}
