I would like to know if there are any proposals for internal file organization, like what to put from top to bottomā¦
Example: start with pub use declarations, then use, the mod, enums, traits, etc.
Iāve seen rustfmt has some options like reorder_imports that may impose some partial structure, but I would like a more comprehensive guide/specā¦
If thereās nothing like that. Can we maybe discuss something that makes sense? š¤
I usually sort them like this and feel like thatās roughly what most people are doing:
mod
statements and respective (pub use
) imports from sub-modulespub
types & functionsGenerally, the logic is public API at the top, internals at the bottom, so that other devs using your module find everything they need at the top.
One exception to that are the imports. Aside from
pub use
, those would be better placed at the bottom. We just seem to put them up top for reasons of Weāve Always Done It This Wayā¢.Thatās more or less what I do. However I usually struggle with enum, traits, functions and structs inside the same group. So, for example, if Iām in the public group:
š¤
I would also definitely recommend hierarchical sorting. So, at the top would be a type typically used when calling your API or the aggregate type holding your internal state etc. and then right below each of these, the types they are composed of.
Reading code requires sifting through tons of complexity and it requires not-sifting through irrelevant complexity. So, I want to know that I need a type before I care about its precise definition.
For multiple, not hierarchically related types, I try to put the most important, most frequently used type at the top.
And I usually put types above functions, as functions can entail a lot of code + details, so I donāt want them ādisplacingā any relevant types.
But yeah, Iām not a fan of hard rules and thereās definitely exceptions to these.
In a codebase at $DAYJOB, we often have
Configuration
types, which are just boilerplate to read out part of a config file and make it easily accessible to the code in this module.No one cares how those
Configuration
types look, so we place them below all the functions.And sometimes, youāll have a module with many types and not really a reason to deem one more important than the other. Then just sorting them alphabetically can be more readable.
Makes sense. Iāve also given a try to the flags I mentioned in rustfmt and they are apparently just for the nightly build, which makes me think they are working on it, which is good news (at least for me).
Sometimes having too much freedom when it comes to organizing code can be worse, I guess. But in general I prefer it to, for example, C, which was so picky with the placements of things.
Thanks for the feedback š
@lemming_7765 since things can be expressed in more or less any order, I like the idea of putting the most important things first and then working down from there.
Not my original idea but I canāt remember the origin.
So, hierarchichal top down, I guess. With main types before subordinate ones. Right?