C#•2y ago•

2 replies

How can I make this library I released better / general thoughts on Result and Unions?

Intro

So a few days ago I released a library called UnionContainers, I've been working on it for a while along with some other libraries and I've also recently gotten some feedback from people over on the dotnet and C# subreddits. I wont go too in depth into the library as I'm not trying to showcase it but want to ask everyone's thoughts on what can be done to make it more user friendly. While I did not get a ton of useful comments, most either just dismissing the idea or not offering any explanations into the down votes I did get a few here or there that pointed out a few key things.

1. The general consensus seemed to be the library API was too complex or hard to follow naturally
2. People seemed to not like that I merged a

Result<T>

Result<T>

and a

Option<T>

Option<T>

types into 1 class
3. Some pointed out issues about non exhaustive matching (the library does enforce it with Roslyn Analyzers but that's probably my fault for not being more direct about that info)

So with that said I would like to show the current implementation, share some thoughts on why I created it and what benefits I see from it, and then propose a more simplified implementation.

The What

So as a hopefully quick summary, the

UnionContainer

UnionContainer

type currently supports 4 main states that it can exist in, those are Empty, Result, Error and Exception. It also can support container creation for between 1 and 16 possible result types. A very basic example would be this

UnionContainer<string> container = "hello";
container.TryHandleResult((String result) => Console.WriteLine($"The container value is: {result}"));
//prints The container value is: hello

UnionContainer<string> container = "hello";
container.TryHandleResult((String result) => Console.WriteLine($"The container value is: {result}"));
//prints The container value is: hello

This on its own does not offer a done of useful functionality since we can obv tell the container has a result given we set it as a string directly. Another example that is a bit more complicated could be something like this

public async Task<HttpResponseMessage> GetHTTPResponseUnion()
{
    var client = new HttpClient();
    UnionContainer<HttpResponseMessage> container = await UnionContainerFactory.MethodToContainer(async () => await client.GetAsync("https://127.0.0.1"));
    return container.TryGetValue(fallbackValue: new HttpResponseMessage())!;
}

public async Task<HttpResponseMessage> GetHTTPResponseUnion()
{
    var client = new HttpClient();
    UnionContainer<HttpResponseMessage> container = await UnionContainerFactory.MethodToContainer(async () => await client.GetAsync("https://127.0.0.1"));
    return container.TryGetValue(fallbackValue: new HttpResponseMessage())!;
}

Here we see the method creates an

HttpClient

HttpClient

executes a get request and then returns the containers result as the return value of the task. This introduces a few important features. The first being the automatic wrapping of a method in a try-catch, when

client.GetAsync

client.GetAsync

fails to connect it will throw an exception, the

MethodToContainer

MethodToContainer

call will see that and save the Exception so it can retrieved later. If the result works however the exception state stays false and instead the result item is populated. An optional value can also provided to

TryGetValue

TryGetValue

that it will return back if your result item isn't present or is null.

A more complete example of using union container and matching it can be seen in this GitHub Gist https://gist.github.com/DragoQCC/28cbf2e9f1c7d2493ac91c64905bcec3 (had to post here due to post character size limit)

The Why

I wanted a result type class that could allow me to return one of a multitude of values, and also keep track of issue states as they arose all at the same time. I did not want to set result types for Empty, Error, and Exception along side the valid result types that I actually want to get back.

The Proposal

My current thoughts are to simplify the language used like TryHandleResult becomes Match, TryGetResult becomes GetResult, and remove the error type.

Closing Thoughts

The library contains some other features like Attributes that let you constrain generics, dynamic / object types for class generics, method arguments, properties, and fields to an allowed list of types as well as some functional extension methods, but I wanted to focus on the main Union / Result type content. Interested to hear your thoughts and any advice / pointers on what can be done to help improve the library.

Gist

UnionContainer-ExampleMatch

UnionContainer-ExampleMatch. GitHub Gist: instantly share code, notes, and snippets.

C#•2y ago•

2 replies

Drago-QCC

How can I make this library I released better / general thoughts on Result and Unions?

Intro

Result<T>

Result<T>

and a

Option<T>

Option<T>

The What

So as a hopefully quick summary, the

UnionContainer

UnionContainer

UnionContainer<string> container = "hello";
container.TryHandleResult((String result) => Console.WriteLine($"The container value is: {result}"));
//prints The container value is: hello

UnionContainer<string> container = "hello";
container.TryHandleResult((String result) => Console.WriteLine($"The container value is: {result}"));
//prints The container value is: hello

public async Task<HttpResponseMessage> GetHTTPResponseUnion()
{
    var client = new HttpClient();
    UnionContainer<HttpResponseMessage> container = await UnionContainerFactory.MethodToContainer(async () => await client.GetAsync("https://127.0.0.1"));
    return container.TryGetValue(fallbackValue: new HttpResponseMessage())!;
}

public async Task<HttpResponseMessage> GetHTTPResponseUnion()
{
    var client = new HttpClient();
    UnionContainer<HttpResponseMessage> container = await UnionContainerFactory.MethodToContainer(async () => await client.GetAsync("https://127.0.0.1"));
    return container.TryGetValue(fallbackValue: new HttpResponseMessage())!;
}

Here we see the method creates an

HttpClient

HttpClient

client.GetAsync

client.GetAsync

fails to connect it will throw an exception, the

MethodToContainer

MethodToContainer

TryGetValue

TryGetValue

The Why

The Proposal

My current thoughts are to simplify the language used like TryHandleResult becomes Match, TryGetResult becomes GetResult, and remove the error type.

Closing Thoughts

Gist

UnionContainer-ExampleMatch

UnionContainer-ExampleMatch. GitHub Gist: instantly share code, notes, and snippets.

How can I make this library I released better / general thoughts on Result and Unions?

Intro

The What

The Why

The Proposal

Closing Thoughts

How can I make this library I released better / general thoughts on Result and Unions?

Intro

The What

The Why

The Proposal

Closing Thoughts

Similar Threads

Similar Threads

Similar Threads