Where do I put stuff in a growing codebase? (programming.dev)

submitted 1 year ago by nerdblood@programming.dev to c/rust@programming.dev

6 comments fedilink hide all child comments

I've mostly been putting functions, structs enums and tests in the same file and it's starting to feel like a mess... I am constantly losing track of which function is where and I'm never quite sure if I have code in the right place. I know this is kind of vague, but that's been my general feeling while working in my largest personal project so far. It's essentially a large Algorithm that has many smaller steps that needs to run in a sequence.

I think I might just have too many loose functions and maybe I should use more impl methods and traits? I'm also thinking I should try the builder pattern in a few spots.

Anyone have any guidance on code organization in rust?

you are viewing a single comment's thread
view the rest of the comments

[-] bobtreehugger@awful.systems 8 points 1 year ago

Functions are fine, don't move to struct impls unless it makes sense (but do if the functions all take the same struct as a param).

You can go pretty far with modules and functions. Group related functions and move them to new modules. You can also hide functions that are only used inside one of the submodules by just not marking them as pub.

One thing that comes to mind is that if the steps of your algorithm all take and return the same data, you can have a trait that expresses that (possibly one of the Fn traits if you're going to just use functions), and you can define and rest each step separately.

It's hard to give more concrete advice without knowing more about your project

this post was submitted on 18 Aug 2023

26 points (93.3% liked)

Rust

6130 readers

45 users here now

Welcome to the Rust community! This is a place to discuss about the Rust programming language.

Wormhole

!performance@programming.dev

Credits

The icon is a modified version of the official rust logo (changing the colors to a gradient and black background)

founded 2 years ago

MODERATORS

snowe@programming.dev

Ategon@programming.dev

EdTheLegendary@programming.dev

kahnclusions@programming.dev

torcherist@programming.dev