[docs-logs] Use struct in the complex type logging demo #5577
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5577 +/- ##
==========================================
+ Coverage 83.38% 85.69% +2.31%
==========================================
Files 297 271 -26
Lines 12531 11376 -1155
==========================================
- Hits 10449 9749 -700
+ Misses 2082 1627 -455
Flags with carried forward coverage won't be shown. Click here to find out more. |
| @@ -34,5 +34,5 @@ internal static partial class LoggerExtensions | |||
| [LoggerMessage(LogLevel.Critical)] | |||
| public static partial void FoodRecallNotice( | |||
| this ILogger logger, | |||
| [LogProperties(OmitReferenceName = true)] FoodRecallNotice foodRecallNotice); | |||
| [LogProperties(OmitReferenceName = true)] in FoodRecallNotice foodRecallNotice); | |||
There was a problem hiding this comment.
in with mutable structs can be tricky. If the compiler can't determine stuff is readonly it will make defensive copies. I think the auto-properties shown here are fine (IIRC the getters get marked as readonly automatically for auto-properties), but users could run into trouble if they handroll more. If we want to recommend in we may also want to recommend the structs be readonly too? readonly struct + in work always.
There was a problem hiding this comment.
Build failed, seems it is only available in .NET Core. I'll revert the change.
reyang
force-pushed
the
reyang/complex-type-logging
branch
from
67d5d42
to
afa7488
Compare
| @@ -1,6 +1,7 @@ | |||
| <Project Sdk="Microsoft.NET.Sdk"> | |||
| <PropertyGroup> | |||
| <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> | |||
| <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> | |||
There was a problem hiding this comment.
This would put the generated source under .\obj\Debug\net8.0\generated\Microsoft.Gen.Logging\Microsoft.Gen.Logging.LoggingGenerator\Logging.g.cs which helps to understand things behind the scene.
There was a problem hiding this comment.
Just FYI in case you weren't aware you can see them in IDE under the analyzer:
reyang
changed the title
Encourage the readers to write performant code.