fsharp / fsharp/fslang-suggestions
Support disposable pattern for `ref` structs
- Dominant language
- No language data
- Stars
- 373
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
I propose we support consuming disposable pattern for [`ref` structs](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/ref-struct):
> You can define a disposable ref struct. To do that, ensure that a ref struct fits the [disposable pattern](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-8.0/using#pattern-based-using). That is, it has an instance or extension Dispose method, which is accessible, parameterless and has a void return type.
In recent C# versions this pattern can be used instead of implementing `IDisposable` in a struct type. If such a change to a struct type is done in a C# project/library, then this type can't be used in a `use` binding in F# anymore, i.e this code:
```fsharp
use x = Library.Method()
...
```
has to be rewritten into this:
```fsharp
let x = Library.Method()
...
x.Dispose()
```
or preferably even this:
```fsharp
let x = Library.Method()
try
...
finally
x.Dispose()
```
The type change doesn't need any changes in referencing C# projects, so library authors may break usages in F# code without realising it.
## Pros and Cons
The advantages of making this adjustment to F# are
* being compatible with a recent C# feature that may be used in referenced libraries/projects; otherwise F# usages may get broken
The disadvantages of making this adjustment to F# are
* it needs work
## Extra information
Estimated cost (XS, S, M, L, XL, XXL): S-M
## Affidavit (please submit!)
Please tick this by placing a cross in the box:
* [x] This is not a question (e.g. like one you might ask on [stackoverflow](http://stackoverflow.com)) and I have searched stackoverflow for discussions of this issue
* [x] I have [searched both open and closed suggestions on this site](http://github.com/fsharp/fslang-suggestions/issues) and believe this is not a duplicate
* [x] This is not something which has obviously "already been decided" in previous versions of F#. If you're questioning a fundamental design decision that has obviously already been taken (e.g. "Make F# untyped") then please don't submit it.
Please tick all that apply:
* [x] This is not a breaking change to the F# language design
* [ ] I or my company would be willing to help implement and/or test this
## For Readers
If you would like to see this issue implemented, please click the :+1: emoji on this issue. These counts are used to generally order the suggestions by engagement.
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no repository files or tests. Start by tracing how F# `use` bindings recognize disposable values, then compare that path with the C# disposable pattern for `ref struct` types. Done means an accessible, parameterless, void `Dispose` on a ref struct is accepted by `use` while preserving cleanup behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, fsharp
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100