// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;

namespace Microsoft.AspNetCore.Localization
{
    /// <summary>
    /// An abstract base class provider for determining the culture information of an <see cref="HttpRequest"/>.
    /// </summary>
    public abstract class RequestCultureProvider : IRequestCultureProvider
    {
        /// <summary>
        /// Result that indicates that this instance of <see cref="RequestCultureProvider" /> could not determine the
        /// request culture.
        /// </summary>
        protected static readonly Task<ProviderCultureResult?> NullProviderCultureResult = Task.FromResult(default(ProviderCultureResult));

        /// <summary>
        /// The current options for the <see cref="RequestLocalizationMiddleware"/>.
        /// </summary>
        public RequestLocalizationOptions? Options { get; set; }

        /// <inheritdoc />
        public abstract Task<ProviderCultureResult?> DetermineProviderCultureResult(HttpContext httpContext);
    }
}
