src/Mvc/Mvc.Core/src/FileStreamResult.cs - main - githubmirror/aspnetcore

src/Mvc/Mvc.Core/src/FileStreamResult.cs
70 строк2 KB
James Newton-King
Enable throw helper analyzers (#45954)
10 янв 2023, 03:52
10 янв 2023, 03:52c096dbb
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics.CodeAnalysis;
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Net.Http.Headers;

namespace Microsoft.AspNetCore.Mvc;

/// <summary>
/// Represents an <see cref="ActionResult"/> that when executed will
/// write a file from a stream to the response.
/// </summary>
public class FileStreamResult : FileResult
{
    private Stream _fileStream;

    /// <summary>
    /// Creates a new <see cref="FileStreamResult"/> instance with
    /// the provided <paramref name="fileStream"/> and the
    /// provided <paramref name="contentType"/>.
    /// </summary>
    /// <param name="fileStream">The stream with the file.</param>
    /// <param name="contentType">The Content-Type header of the response.</param>
    public FileStreamResult(Stream fileStream, string contentType)
        : this(fileStream, MediaTypeHeaderValue.Parse(contentType))
    {
    }

    /// <summary>
    /// Creates a new <see cref="FileStreamResult"/> instance with
    /// the provided <paramref name="fileStream"/> and the
    /// provided <paramref name="contentType"/>.
    /// </summary>
    /// <param name="fileStream">The stream with the file.</param>
    /// <param name="contentType">The Content-Type header of the response.</param>
    public FileStreamResult(Stream fileStream, MediaTypeHeaderValue contentType)
        : base(contentType.ToString())
    {
        ArgumentNullException.ThrowIfNull(fileStream);

        FileStream = fileStream;
    }

    /// <summary>
    /// Gets or sets the stream with the file that will be sent back as the response.
    /// </summary>
    public Stream FileStream
    {
        get => _fileStream;

        [MemberNotNull(nameof(_fileStream))]
        set
        {
            ArgumentNullException.ThrowIfNull(value);

            _fileStream = value;
        }
    }

    /// <inheritdoc />
    public override Task ExecuteResultAsync(ActionContext context)
    {
        ArgumentNullException.ThrowIfNull(context);

        var executor = context.HttpContext.RequestServices.GetRequiredService<IActionResultExecutor<FileStreamResult>>();
        return executor.ExecuteAsync(context, this);
    }
}