gomemlayout is a Visual Studio Code extension designed to optimize the memory layout of Go structs. It provides tools to analyze and improve struct layouts, reducing memory padding and improving efficiency.
- CodeLens Actions: Adds a CodeLens above each Go struct to optimize its layout.
- Visual Decorations: Highlights padding and inefficiencies in struct layouts directly in the editor.
- Automatic Optimization: Reorganizes struct fields to minimize padding with a single command.
- Support for Nested Structs: Handles and optimizes structs with nested fields.
While gomemlayout provides powerful tools for optimizing Go structs, there are some limitations to be aware of:
- Complex Structs: Structs with deeply nested fields at second level or highly complex layouts may not be fully optimized. This could be supporteb but discouraged as use case.
- Custom Types: The extension relies on a predefined
layoutMapfor type sizes including all common and base type in Go. Custom types not included in this map may not be handled correctly. The approach is conservative and they will be treated as smallest in the analyzed structs.
- Go must be installed on your system.
- A Go file must be open in the editor for the extension to work.
This extension does not currently add any configurable settings.
The extension provides the following commands:
gomemlayout.optimize: Optimizes the layout of a selected struct.
- Structs with highly complex layouts may take longer to analyze.
- Decorations may not update correctly in some edge cases when the file is modified rapidly.
- Initial release with:
- CodeLens for struct optimization.
- Visual decorations for padding and inefficiencies.
- Command to optimize struct layouts.
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\on macOS orCtrl+\on Windows and Linux). - Toggle preview (
Shift+Cmd+Von macOS orShift+Ctrl+Von Windows and Linux). - Press
Ctrl+Space(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!