Repository navigation
Encapsulate relay::client::Connection into an Newtype type that only exposes AsyncRead and AsyncWrite #3255
Description
Motivation
As per #3238/files#r1050261660 Connection is a public enum variant with struct variants, any change to it becomes a subsequent breaking change.
Desired changes
Encapsulate that one into an Newtype that only exposes AsyncRead and AsyncWrite as its interface:
- Rename the type to
ConnectionState& make it private - Create a struct
Connectionas Newtype that encapsulatesConnectionState. - Move the AsyncRead and AsyncWrite implementations from the enum to the struct
this depends on #3238 as it renames RelayedConnection to Connection and is itself a breaking change. Probably should also wait on the discussion started on #3221 (comment).
Are you planning to do it yourself in a pull request?
Yes if required.
Reacted by Thomas Eizinger
Activity
mxinden commentedon Dec 19, 2022
Sounds good to me. Thanks for documenting it.
Danijel-Enoch commentedon Feb 10, 2023
Hello guys I am new to Open Source Contribution . Can I try this?
thomaseizinger commentedon Feb 10, 2023
Sure thing! Let me know if you need more mentoring or any other help :)
Best to have a go yourself and open a draft PR if you get stuck, then we can discuss things there!
Danijel-Enoch commentedon Feb 10, 2023
Thanks
Would get started
feat(relay): hide internals of `Connection`
feat(relay): hide internals of `Connection`