Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename IUnionEncoder to IEventCodec #27

Closed
bartelink opened this issue Nov 3, 2019 · 0 comments · Fixed by #29
Closed

Rename IUnionEncoder to IEventCodec #27

bartelink opened this issue Nov 3, 2019 · 0 comments · Fixed by #29
Milestone
2.0

Comments

@bartelink
Copy link
Collaborator

While the encoding support started as a very light wrapper of the TypeShape UnionEncoder (before it was called that!). However

  • the base interface does not rely on or special case Unions in any way
  • is equally focused on encoding and decoding

So... in V2 we should thus consider renaming IUnionEncoder to IEventCodec.
https://github.com/jet/FsCodec/blob/master/src/FsCodec/FsCodec.fs#L31

As this will be a breaking change, it should accompany some meaningful new feature, i.e. #14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.0
Development

Successfully merging a pull request may close this issue.

Rename IUnionEncoder -> IEventCodec w/ examples and docs re #27 jet/FsCodec
1 participant
@bartelink