What should be in the root namespace?

[dkrautha]

As I'm working on integration tests I'm trying to decide what deserves a place in the "root" namespace of the crate. As an example, how should XbfPrimitive be imported:

// Option 1
use xbf_rs::XbfPrimitive;
// Option 2
use xbf_rs::xbf_primitive::XbfPrimitive;

This is also somewhat dependent on #35 and how that turns out. It might make the most sense to have the conversions at the root of the crate so that the user never actually has to type XbfPrimitive and can just use the named conversions to get what they want.

[dkrautha]

Forgot to put in the first message, looking for feedback from @ahuston-0 @hydrodog @Themadmaker2.

[hydrodog]

Why should the package have _rs in the name? Isn't everything in rust arguably _rs? Is this to distringuish from a native C++ implementation wrapped in rust? Or are you worried that xbf is too short and someone else might have taken it?

I would prefer xbf. If you want a more descriptive name, maybe xbf_transport for the lowest level, and xbf_ds for the data structures you want to layer on top?

[dkrautha]

Talked with Richie about this, I think we both like having the import be:

use xbf_rs::XbfPrimitive

As the user doesn't really need to care about how things are structured internally, and having stuff easily accessible at the root namespace makes sense.

To answer the _rs question, I think it makes sense when this is a Rust implementation of something that could be and hopefully will be implemented in other languages at some point. See Alice starting work on the Kotlin version in #13, which is currently named xbf_kt I believe.

I've checked crates.io and nobody has taken the name xbf, so if we wanted it we could have it.

I think having the suffix of what language its implemented in makes sense, as ideally when you look up XBF on google you should find the GitHub organization and the spec, and then if you want an implementation in a certain language you can find that with the suffix. If there's multiple implementations all named xbf then it'll be hard to distinguish between which one is which.