-
Notifications
You must be signed in to change notification settings - Fork 6k
Add marshaller shape docs to docs with more detailed explanations #47125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jtschuster
wants to merge
7
commits into
dotnet:main
Choose a base branch
from
jtschuster:MarshallerShapes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+972
−39
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
gewarren
approved these changes
Jul 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, I left a few suggestions.
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
docs/standard/native-interop/custom-marshalling-source-generation.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Genevieve Warren <[email protected]>
jtschuster
commented
Jul 16, 2025
|
||
## Marshaller shapes | ||
|
||
The set of methods that the marshalling generator expects from a custom marshaller type is referred to as the *marshaller shape*. To support stateless, static custom marshaller types in .NET Standard 2.0 (which doesn't support static interface methods), and improve performance, interface types are not used to define and implement the marshaller shapes. Instead, the shapes are documented in the [Custom marshaller shapes](custom-marshaller-shapes.md) article. The expected methods (or shape) depends on the whether the marshaller is stateless or stateful, and whether it supports marshalling from managed to unmanaged, unmanaged to managed, or both (declared with `CustomMarshallerAttribute.MarshalMode`). The .NET SDK includes analyzers and code fixers to help with implementing marshallers that conform to the required shapes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jkoritzinsky @AaronRobinsonMSFT Is this accurate and complete?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Describe your changes here.
Fixes dotnet/runtime#116403
Internal previews