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.

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

Rename crate #1

Closed
xoac opened this issue Jan 22, 2020 · 6 comments
Closed

Rename crate #1

xoac opened this issue Jan 22, 2020 · 6 comments

Comments

@xoac
Copy link
Owner

xoac commented Jan 22, 2020

I am not quite sure name of this crate is correct. The same suggest it works with serde but it doesn't.

It transform rust types as little or big endiannes.

Any suggestions are welcome.

@xoac xoac added this to the publish-to-crate-io milestone Jan 22, 2020
@chrysn
Copy link

chrysn commented Jan 22, 2020

packed-endian-struct, maybe (given that the serialization it produces doesn't have padding AFAICT)?

@xoac
Copy link
Owner Author

xoac commented Jan 31, 2020

I would propose endian_codec and I decide to use _ after reading this issue

This will also change SerializeLittleEndain trait to EncodeLEetc. because the name was to long in practical use.

xoac added a commit that referenced this issue Jan 31, 2020
@xoac xoac closed this as completed Feb 2, 2020
@Kixunil
Copy link

Kixunil commented Apr 7, 2020

How about binary_codec?

@wucke13
Copy link
Contributor

wucke13 commented Apr 7, 2020

Quite nice, that name! I suppose that both of you have a look of packed_struct. It looks like it is unmaintained, and the ergonomics are not super good (e.g. I wasn't able to get started in 20 minutes), however, feature wise it looks really complete & good.

@xoac
Copy link
Owner Author

xoac commented Apr 7, 2020

Renaming create is still an option. But:

  • it has to be much better name (not just better)
  • crate has to be fully implemented

I think that the name is lacking of pack word so it could be pack_(with)_endian or struct_pack_endian, endian_packed packed_struct. I think pack should replace codec since it can pack and unpack objects what is a special case of codec.

I would at this moment vote against change the name. Why?:

  • the crate is not supper important
  • it's already published to crates.io
  • crate can be found by adding category and keywords
    at this moment there are still free slots (and endian can be removed - it's in name)
      keywords = ["no_std", "endian", "bytes"]
      categories = ["no-std", "parsing"]
    
  • This crate will be probably useful with no_std environment so I added it to awesome-emebedded-rust to be easier findable

I will not go with binary_codec - because can codec be done without binary?

I still think that endian is good part in name: Look at documentation:
image
just PackedSize don't contains endain in name. At it's just helping trait that I would be happy to hide from the end user.

@Kixunil
Copy link

Kixunil commented Apr 8, 2020

I definitely agree with not jumping on renaming too soon! I meant it more as a suggestion if the situation changes.

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

No branches or pull requests

4 participants