File: Workspace\Host\PersistentStorage\SolutionKey.cs
Web Access
Project: ..\..\..\src\Workspaces\Core\Portable\Microsoft.CodeAnalysis.Workspaces.csproj (Microsoft.CodeAnalysis.Workspaces)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
 
using System.Runtime.Serialization;
using Microsoft.CodeAnalysis.Host;
 
namespace Microsoft.CodeAnalysis.Storage
{
    /// <summary>
    /// Handle that can be used with <see cref="IChecksummedPersistentStorage"/> to read data for a
    /// <see cref="Solution"/> without needing to have the entire <see cref="Solution"/> snapshot available.
    /// This is useful for cases where acquiring an entire snapshot might be expensive (for example, during 
    /// solution load), but querying the data is still desired.
    /// </summary>
    [DataContract]
    internal readonly struct SolutionKey
    {
        [DataMember(Order = 0)]
        public readonly SolutionId Id;
 
        [DataMember(Order = 1)]
        public readonly string? FilePath;
 
        public SolutionKey(SolutionId id, string? filePath)
        {
            Id = id;
            FilePath = filePath;
        }
 
        public static SolutionKey ToSolutionKey(Solution solution)
            => ToSolutionKey(solution.State);
 
        public static SolutionKey ToSolutionKey(SolutionState solutionState)
            => new(solutionState.Id, solutionState.FilePath);
    }
}