rustls / rustls-ffi

Use Rustls from any language
Other
128 stars 30 forks source link

doc: document handling of dynamically sized types #364

Closed jsha closed 10 months ago

jsha commented 10 months ago

Following up on the conversation in https://github.com/rustls/rustls-ffi/pull/341#issuecomment-1749605419 about how to handle Arc<dyn Foo> in the Rustls API. I decided to document this in the CONTRIBUTING.md; we can link to this sub-heading as needed.

jsha commented 10 months ago

I think extensive coverage of the try_xxx macros is probably too much detail, but maybe it would be worth a brief mention of their existence to direct an interested reader to their location in lib.rs? WDYT?

This is a good idea but I don't think it's tightly bound to the DSTs explanation so I'll do it in a followup.