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

src/Mvc/Mvc.Core/src/FileResult.cs

58 строк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.Net.Http.Headers;

namespace Microsoft.AspNetCore.Mvc;

/// <summary>
/// Represents an <see cref="ActionResult"/> that when executed will
/// write a file as the response.
/// </summary>
public abstract class FileResult : ActionResult
{
    private string? _fileDownloadName;

    /// <summary>
    /// Creates a new <see cref="FileResult"/> instance with
    /// the provided <paramref name="contentType"/>.
    /// </summary>
    /// <param name="contentType">The Content-Type header of the response.</param>
    protected FileResult(string contentType)
    {
        ArgumentNullException.ThrowIfNull(contentType);

        ContentType = contentType;
    }

    /// <summary>
    /// Gets the Content-Type header for the response.
    /// </summary>
    public string ContentType { get; }

    /// <summary>
    /// Gets the file name that will be used in the Content-Disposition header of the response.
    /// </summary>
    [AllowNull]
    public string FileDownloadName
    {
        get { return _fileDownloadName ?? string.Empty; }
        set { _fileDownloadName = value; }
    }

    /// <summary>
    /// Gets or sets the last modified information associated with the <see cref="FileResult"/>.
    /// </summary>
    public DateTimeOffset? LastModified { get; set; }

    /// <summary>
    /// Gets or sets the etag associated with the <see cref="FileResult"/>.
    /// </summary>
    public EntityTagHeaderValue? EntityTag { get; set; }

    /// <summary>
    /// Gets or sets the value that enables range processing for the <see cref="FileResult"/>.
    /// </summary>
    public bool EnableRangeProcessing { get; set; }
}