Align pbandk's naming with the conventions in recent Kotlin releases #89
Labels
enhancement
New feature or request
Milestone
Comments
garyp
added a commit
that referenced
this issue
Sep 12, 2020
- Rename "marshal"/"unmarshal" to "encode"/"decode" in all methods and classes - Standardize encoding/decoding methods to be named `encodeTo*` and `decodeFrom*`, similar to naming used in the standard libraries - Rename the low-level `marshal(MessageMarshaller)` and `unmarshal(MessageUnmarshaller)` methods to `encodeWith(MessageEncoder)` and `decodeWith(MessageDecoder)` Fixes #89
garyp
added a commit
that referenced
this issue
Sep 14, 2020
- Rename "marshal"/"unmarshal" to "encode"/"decode" in all methods and classes - Standardize encoding/decoding methods to be named `encodeTo*` and `decodeFrom*`, similar to naming used in the standard libraries - Rename the low-level `marshal(MessageMarshaller)` and `unmarshal(MessageUnmarshaller)` methods to `encodeWith(MessageEncoder)` and `decodeWith(MessageDecoder)` Fixes #89
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Kotlin is starting to standardize on some naming patterns in its standard library and related libraries (like kotlinx-serialization and kotlinx-coroutines). For example, see some of the naming changes introduced in https://github.com/Kotlin/kotlinx.serialization/releases/tag/1.0.0-RC. pbandk should adopt similar naming conventions so that pbandk's API feels more idiomatic and familiar to Kotlin developers.
Specifically, this includes replacing the "marshal"/"unmarshal" terminology with "encode"/"decode" and renaming methods such as
Message.protoMarshal()toMessage.encodeToByteArray()andMessage.jsonUnmarshal(String)toMessage.decodeFromJsonString(String).The text was updated successfully, but these errors were encountered: