Merge pull request #76 from KinsonDigital/preview/v1.0.0-preview.13

🚀Preview Release

Carbonate/BiDirectional/IPullReactable.cs

@@ -10,8 +10,8 @@ namespace Carbonate.BiDirectional;
 /// <summary>
 /// Defines a provider for pull-based responses.
 /// </summary>
-/// <typeparam name="TDataIn">The type of data packaged in the outgoing <see cref="IMessage{TDataIn}"/>.</typeparam>
-/// <typeparam name="TDataOut">The type of data to pull.</typeparam>
+/// <typeparam name="TDataIn">The type of data coming in.</typeparam>
+/// <typeparam name="TDataOut">The type of data going out.</typeparam>
 public interface IPullReactable<TDataIn, TDataOut> : IReactable<IRespondReactor<TDataIn, TDataOut>>, IPullable<TDataIn, TDataOut>
 {
 }

Carbonate/BiDirectional/IPullable.cs

@@ -5,24 +5,22 @@
 namespace Carbonate.BiDirectional;
 
 using System.Diagnostics.CodeAnalysis;
-using Core;
 
 /// <summary>
 /// Gives the ability to pull data from a source using a messaging mechanism.
 /// </summary>
-/// <typeparam name="TDataIn">The type of data packaged in the <see cref="IMessage{TDataIn}"/>.</typeparam>
-/// <typeparam name="TDataOut">The type of data to be pulled.</typeparam>
+/// <typeparam name="TDataIn">The type of data coming in.</typeparam>
+/// <typeparam name="TDataOut">The type of data going out.</typeparam>
 public interface IPullable<TDataIn, out TDataOut>
 {
     /// <summary>
     /// Requests to pull data from a source that matches the given <paramref name="respondId"/>,
-    /// with the given additional <paramref name="msg"/>.
+    /// with the given additional <paramref name="data"/>.
     /// </summary>
-    /// <param name="msg">The data to send to the responder.</param>
+    /// <param name="data">The data to send to the responder.</param>
     /// <param name="respondId">The ID of the response.</param>
-    /// <typeparam name="TDataOut">The type of data to send to the responder.</typeparam>
-    /// <returns>The response result.</returns>
+    /// <returns>The data result going out.</returns>
     [SuppressMessage("ReSharper", "UnusedParameter.Global", Justification = "Public API.")]
     [SuppressMessage("ReSharper", "UnusedMemberInSuper.Global", Justification = "Public API.")]
-    IResult<TDataOut> Pull(in IMessage<TDataIn> msg, Guid respondId);
+    TDataOut? Pull(in TDataIn data, Guid respondId);
 }

Carbonate/BiDirectional/PullReactable.cs

@@ -7,15 +7,14 @@
 // ReSharper disable LoopCanBeConvertedToQuery
 namespace Carbonate.BiDirectional;
 
-using Core;
 using Core.BiDirectional;
 
 /// <inheritdoc cref="IPullReactable{TDataIn,TDataOut}"/>
 public class PullReactable<TDataIn, TDataOut>
     : ReactableBase<IRespondReactor<TDataIn, TDataOut>>, IPullReactable<TDataIn, TDataOut>
 {
     /// <inheritdoc/>
-    public IResult<TDataOut> Pull(in IMessage<TDataIn> msg, Guid respondId)
+    public TDataOut? Pull(in TDataIn data, Guid respondId)
     {
         for (var i = 0; i < Reactors.Count; i++)
         {
@@ -24,11 +23,9 @@ public IResult<TDataOut> Pull(in IMessage<TDataIn> msg, Guid respondId)
                 continue;
             }
 
-            var result = Reactors[i].OnRespond(msg);
-
-            return result ?? ResultFactory.CreateEmptyResult<TDataOut>();
+            return Reactors[i].OnRespond(data);
         }
 
-        return ResultFactory.CreateEmptyResult<TDataOut>();
+        return default(TDataOut);
     }
 }

Carbonate/BiDirectional/RespondReactor.cs

@@ -4,20 +4,19 @@
 
 namespace Carbonate.BiDirectional;
 
-using Core;
 using Core.BiDirectional;
 
 /// <inheritdoc cref="IRespondReactor{TDataIn,TDataOut}"/>
 public sealed class RespondReactor<TDataIn, TDataOut> : ReactorBase, IRespondReactor<TDataIn, TDataOut>
 {
-    private readonly Func<IMessage<TDataIn>, IResult<TDataOut>?>? onRespondMsg;
+    private readonly Func<TDataIn, TDataOut?>? onRespondData;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="RespondReactor{TDataIn,TDataOut}"/> class.
     /// </summary>
     /// <param name="respondId">The ID of the <see cref="PullReactable{TDataIn,TDataOut}"/> requiring a response.</param>
     /// <param name="name">The name of the <see cref="RespondReactor{TDataIn,TDataOut}"/>.</param>
-    /// <param name="onRespondMsg">Executed when requesting a response with data.</param>
+    /// <param name="onRespondData">Executed when requesting a response with data.</param>
     /// <param name="onUnsubscribe">
     ///     Executed when the provider has finished sending push-based notifications and is unsubscribed.
     /// </param>
@@ -30,25 +29,25 @@ public sealed class RespondReactor<TDataIn, TDataOut> : ReactorBase, IRespondRea
     public RespondReactor(
         Guid respondId,
         string name = "",
-        Func<IMessage<TDataIn>, IResult<TDataOut>?>? onRespondMsg = null,
+        Func<TDataIn, TDataOut?>? onRespondData = null,
         Action? onUnsubscribe = null,
         Action<Exception>? onError = null)
-            : base(respondId, name, onUnsubscribe, onError) => this.onRespondMsg = onRespondMsg;
+            : base(respondId, name, onUnsubscribe, onError) => this.onRespondData = onRespondData;
 
     /// <inheritdoc/>
-    public IResult<TDataOut> OnRespond(IMessage<TDataIn> message)
+    public TDataOut? OnRespond(TDataIn data)
     {
         if (Unsubscribed)
         {
-            return ResultFactory.CreateEmptyResult<TDataOut>();
+            return default(TDataOut);
         }
 
-        if (message is null)
+        if (data is null)
         {
-            throw new ArgumentNullException(nameof(message), "The parameter must not be null.");
+            throw new ArgumentNullException(nameof(data), "The parameter must not be null.");
         }
 
-        return this.onRespondMsg?.Invoke(message) ?? ResultFactory.CreateEmptyResult<TDataOut>();
+        return this.onRespondData is null ? default(TDataOut) : this.onRespondData.Invoke(data);
     }
 
    /// <inheritdoc cref="object.ToString"/>

Carbonate/Carbonate.csproj

@@ -7,10 +7,10 @@
         <Nullable>enable</Nullable>
 
         <!--Update this for production and preview releases-->
-        <Version>1.0.0-preview.12</Version>
+        <Version>1.0.0-preview.13</Version>
 
         <!--Update this for production and preview releases-->
-        <FileVersion>1.0.0-preview.12</FileVersion>
+        <FileVersion>1.0.0-preview.13</FileVersion>
 
         <!--
           DO NOT UPDATE THIS FOR PREVIEW RELEASES!!
@@ -23,7 +23,7 @@
         <Company>Kinson Digital</Company>
         <Product>Carbonate</Product>
         <Description>Library for doing internal messaging using the observable pattern.</Description>
-        <Copyright>Copyright ©2022 Kinson Digital</Copyright>
+        <Copyright>Copyright ©2023 Kinson Digital</Copyright>
         <PackageTags>messaging observable subscribe</PackageTags>
         <RootNamespace>Carbonate</RootNamespace>
         <ApplicationIcon>carbonate-logo.ico</ApplicationIcon>
@@ -41,6 +41,10 @@
         <Configurations>Debug;Release</Configurations>
     </PropertyGroup>
 
+    <PropertyGroup>
+      <DocumentationFile>bin\x64\Carbonate.xml</DocumentationFile>
+    </PropertyGroup>
+
     <ItemGroup>
         <None Include="carbonate-logo.ico" Pack="true" PackagePath="\" />
         <None Include="..\Documentation\Images\carbonate-logo-light-mode.png" Pack="true" PackagePath="\" />

Carbonate/Core/BiDirectional/IRespondReactor.cs

@@ -7,8 +7,8 @@ namespace Carbonate.Core.BiDirectional;
 /// <summary>
 /// Provides a mechanism for receiving responses.
 /// </summary>
-/// <typeparam name="TDataIn">The type of data packaged in the incoming <see cref="IMessage{TDataIn}"/>.</typeparam>
-/// <typeparam name="TDataOut">The type of data being returned in the response.</typeparam>
+/// <typeparam name="TDataIn">The type of data coming in.</typeparam>
+/// <typeparam name="TDataOut">The type of data going out.</typeparam>
 public interface IRespondReactor<in TDataIn, out TDataOut> : IReactor, IResponder<TDataIn, TDataOut>
 {
 }

Carbonate/Core/BiDirectional/IResponder.cs

@@ -7,14 +7,14 @@ namespace Carbonate.Core.BiDirectional;
 /// <summary>
 /// Gives the ability to respond to a pull request from an <see cref="IReactable{IResponder}"/>.
 /// </summary>
-/// <typeparam name="TDataIn">The data packaged in the <see cref="IMessage{TDataIn}"/>.</typeparam>
-/// <typeparam name="TDataOut">The type of data being returned in the <see cref="IResult{TDataOut}"/>.</typeparam>
+/// <typeparam name="TDataIn">The type of data coming in.</typeparam>
+/// <typeparam name="TDataOut">The type of data going out.</typeparam>
 public interface IResponder<in TDataIn, out TDataOut>
 {
     /// <summary>
     /// Returns a response.
     /// </summary>
-    /// <param name="message">The message for the <see cref="IReactable{IResponder}"/>.</param>
-    /// <returns>The response result.</returns>
-    IResult<TDataOut>? OnRespond(IMessage<TDataIn> message);
+    /// <param name="data">The data for the <see cref="IReactable{IResponder}"/>.</param>
+    /// <returns>The data result going out.</returns>>
+    TDataOut? OnRespond(TDataIn data);
 }

Carbonate/Core/UniDirectional/IReceiveReactor.cs

@@ -7,7 +7,7 @@ namespace Carbonate.Core.UniDirectional;
 /// <summary>
 /// A reactor capable of standard functionality that can receive push notifications.
 /// </summary>
-/// <typeparam name="TDataIn">The data packaged in the message received.</typeparam>
+/// <typeparam name="TDataIn">The type of data coming in.</typeparam>
 public interface IReceiveReactor<in TDataIn> : IReactor, IReceiver<TDataIn>
 {
 }