Proposal: Add a TreatAsString field to QueryAttribute
#1943
Conversation
|
I am open to suggestions on how to implement this functionality. In many of my project, both professional and personal, I find myself adding The solution could also work on types not owned by the implementer such as passing a GUID as a query parameter.
|
The proposal arises from the need to pass custom types or structs which might represent types with rules and conversions.
For example:
```csharp
record readonly struct ZipCode(ushort ZipCode) {
public override string ToString() =>
ZipCode.ToString();
}
```
To solve the problem the proposal seeks to add a field to the QueryAttribute called `TreatAsString`.
The new field is used when the query string is created and simply calls the `ToString()` function on a type.
There is a workaround that is not documented. The current workaround is to implement `IFormattable` on the type, which feels redundant if `ToString()` is already implemented on a custom type.
|
Hi @mark-pro , Thank you for your PR, please could you update it so that it builds, I cannot see the build logs so am unaware if there was any issue during the Github actions build. |
|
@ChrisPulman I will work to get have the project build successfully and will provide and updated here again when it is. |
|
@ChrisPulman I have updated the unit tests. They are now passing in my fork of the project. The project runs the build action to completion. The latest build run is awaiting approval.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1943 +/- ##
==========================================
- Coverage 87.73% 83.09% -4.64%
==========================================
Files 33 37 +4
Lines 2348 2650 +302
Branches 294 381 +87
==========================================
+ Hits 2060 2202 +142
- Misses 208 362 +154
- Partials 80 86 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
The proposal arises from the need to pass custom types or structs which might represent types with rules and conversions. Most of these types can override
ToString()which can then be called when constructing query parameters.For example:
To solve the problem the proposal seeks to add a field to the QueryAttribute called
TreatAsString.The new field is used when the query string is created and simply calls the
ToString()function on a type.There is a workaround that is not documented. The current workaround is to implement
IFormattableon the type, which feels redundant ifToString()is already implemented on a custom type.