Skip to content

docs: struct pass/return examples + ROADMAP update (closes #58) - #69

Merged
kolkov merged 1 commit into
mainfrom
docs/struct-examples
Aug 2, 2026
Merged

docs: struct pass/return examples + ROADMAP update (closes #58)#69
kolkov merged 1 commit into
mainfrom
docs/struct-examples

Conversation

@kolkov

@kolkov kolkov commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add examples/struct/ with C library + Go example covering all struct ABI patterns
  • Add "Passing and Returning Structs" section to README
  • Update ROADMAP to v0.6.3 with full version history (v0.6.1-v0.6.3)

Struct Example Covers

  • TypeDescriptor construction (Size/Alignment/Members)
  • Struct return ≤16B (registers) and >16B (sret)
  • Struct pass-by-value as argument
  • Windows AMD64 float limitation note
  • Integer-only structs for cross-platform compatibility

Test plan

  • go build ./... + both examples compile
  • go test ./... — all pass
  • golangci-lint: 0 issues
  • Cross-compile 5 platforms ✅
  • CI green

Closes #58

Add examples/struct/ with C library and Go example demonstrating
struct TypeDescriptor construction, pass-by-value arguments, and
struct return values (<=16B via registers, >16B via sret).

Add "Struct Pass/Return" section to README with inline code example
and Windows float limitation note.
@codecov

codecov Bot commented Aug 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kolkov
kolkov merged commit 1467582 into main Aug 2, 2026
15 checks passed
@kolkov
kolkov deleted the docs/struct-examples branch August 2, 2026 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Example of passing and returning Go structs

1 participant