Merge pull request #2024 from microsoft/feat/result-deconstruct

feat: adds deconstructor to read result

Author: baywet

src/Microsoft.OpenApi/Reader/ReadResult.cs

@@ -18,5 +18,13 @@ public class ReadResult
         /// OpenApiDiagnostic contains the Errors reported while parsing
         /// </summary>
         public OpenApiDiagnostic Diagnostic { get; set; }
+        /// <summary>
+        /// Deconstructs the result for easier assignment on the client application.
+        /// </summary>
+        public void Deconstruct(out OpenApiDocument document, out OpenApiDiagnostic diagnostic)
+        {
+            document = Document;
+            diagnostic = Diagnostic;
+        }
     }
 }

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -1380,6 +1380,7 @@ namespace Microsoft.OpenApi.Reader
         public ReadResult() { }
         public Microsoft.OpenApi.Reader.OpenApiDiagnostic Diagnostic { get; set; }
         public Microsoft.OpenApi.Models.OpenApiDocument Document { get; set; }
+        public void Deconstruct(out Microsoft.OpenApi.Models.OpenApiDocument document, out Microsoft.OpenApi.Reader.OpenApiDiagnostic diagnostic) { }
     }
     public enum ReferenceResolutionSetting
     {

test/Microsoft.OpenApi.Tests/Reader/ReadResultTests.cs

@@ -0,0 +1,21 @@
+using Xunit;
+using Microsoft.OpenApi.Reader;
+using Microsoft.OpenApi.Models;
+
+namespace Microsoft.OpenApi.Tests.Reader;
+
+public class ReadResultTests
+{
+    [Fact]
+    public void Deconstructs()
+    {
+        var readResult = new ReadResult()
+        {
+            Document = new OpenApiDocument(),
+            Diagnostic = new OpenApiDiagnostic()
+        };
+        var (document, diagnostic) = readResult;
+        Assert.Equal(readResult.Document, document);
+        Assert.Equal(readResult.Diagnostic, diagnostic);
+    }
+}