Skip to content

Conversation

@Xuanwo
Copy link
Collaborator

@Xuanwo Xuanwo commented Sep 9, 2025

This PR was primarily authored with Codex using GPT-5 and then hand-reviewed by me. I AM responsible for every change made in this PR. I aimed to keep it aligned with our goals, though I may have missed minor issues. Please flag anything that feels off, I'll fix it quickly.


Summary

  • Adds a detailed README.md for the examples/folly directory
  • Documents the bidirectional async interoperability between Rust and Facebook's Folly framework
  • Covers all key features demonstrated in the example

What's included

  • Overview of the Rust-Folly async integration
  • Detailed explanations of key components (bridge definitions, async functions, test suite)
  • Feature demonstrations with code snippets:
    • Parallel computation (dot product)
    • Exception/error handling across language boundaries
    • Async streams (FizzBuzz generator example)
    • Ping-pong pattern for multiple async calls
  • Build and run instructions
  • Test coverage details
  • Architecture notes (thread pools, memory management, type mappings)
  • Performance considerations

Related Issue

Closes #14

Test plan

  • Documentation follows existing codebase patterns
  • All code examples are taken from actual implementation
  • Build/run instructions verified
  • Review by maintainers for accuracy and completeness

cc @devillove084 - as mentioned in the issue, happy to have your review on this documentation!

This commit adds a detailed README.md for the Folly integration example,
covering:

- Bidirectional async calls between Rust and C++
- Parallel computation with both coroutines and futures
- Exception handling across language boundaries
- Stream processing and complex communication patterns
- Complete build requirements and troubleshooting guide
- Comprehensive test coverage documentation

The documentation provides clear setup instructions, architecture
overview, and practical examples for developers wanting to understand
Folly-based async interoperability.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@Xuanwo Xuanwo force-pushed the 14/add-docs-for-examples-folly branch from 45f3a26 to 64d3936 Compare September 11, 2025 05:26
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.

Add docs for examples/folly

2 participants