This content originally appeared on DEV Community and was authored by Abinash Sahoo
In Rust, controlling who can access your functions is important for writing clean, secure code. Most developers know about pub and private functions, but let’s take a step further and explore more advanced visibility options.
Here is the link to the full code. Click here!
Basic Visibility: Public and Private Functions
At the simplest level, functions in Rust are either public or private:
fn private_function() {
println!("Private function");
}
pub fn public_function() {
println!("Public function");
}
- Private functions are the default. They are only visible within the same module in which they are defined.
-
Public functions are made public using
pub, making them accessible anywhere in your crate or by other crates (if used in a library).
This is where most developers start. You can make a function public if you need to share it or keep it private for internal logic. But what if you need more fine-grained control? That’s where advanced pub options come in! 🚀
Advanced Functions Visibility: Getting Granular
Sometimes, you don’t want to make a function completely public. You just want it available in certain parts of your code without exposing it everywhere. Let’s look at how Rust gives you this control.
1. Public within a specific module
pub(in crate::my_mod) fn public_function_in_my_mod() {
println!("Visible only inside my_mod");
}
📌 What it does: This function is visible only within the my_mod module. Outside of it, the function remains inaccessible.
🔍 Use case: When you have a helper function that should only be used within a specific module and should not be exposed to other parts of the codebase.
2. Public to the parent module
pub(super) fn public_function_in_super_mod() {
println!("Visible to the parent module");
}
📌 What it does: This makes the function visible only to the parent module.
🔍 Use case: If the parent module needs access to a child’s function without exposing that function more broadly, this is a great option. It keeps your code organized and reduces unwanted access.
3. Public within the entire crate
pub(crate) fn public_function_in_crate() {
println!("Visible within the crate");
}
📌 What it does: The function is accessible anywhere within the crate but is still hidden from other crates.
🔍 Use case: Use this when you want all modules in your crate to have access to the function but don’t want to expose it outside the crate. This is often useful for internal functionality that shouldn’t be part of your public API.
Why Does This Matter?
Rust’s advanced pub keyword allows you to limit access to your functions precisely, which:
- Protects internal code from accidental misuse by other modules or developers.
- Keeps your code secure by limiting what is exposed to external crates.
- Helps you write organized code by giving access only where needed.
Let’s say you have a complex project with several modules. If you expose too much, other parts of your code might depend on internal logic, making it harder to maintain.
On the other hand, hiding everything might make the code less reusable. Rust’s pub keyword options give you the perfect balance!
Conclusion
By using the pub(in path), pub(super), and pub(crate) options, you can:
- Control exactly who can use your functions.
- Keep internal logic private while allowing specific modules or crates to access the necessary functionality.
- Write cleaner, more maintainable code.
Ready to Try It?
Give these pub visibility options a try in your next Rust project! 🎯 You’ll be surprised at how much more flexible and organized your code can be. Got questions? Drop a comment below, and let’s chat! 😊
Have a great day.
Happy Rust Journey!🦀
This content originally appeared on DEV Community and was authored by Abinash Sahoo
Abinash Sahoo | Sciencx (2024-10-02T11:33:37+00:00) Managing Function Visibility in Rust🦀 with “pub”: A Simple Guide. Retrieved from https://www.scien.cx/2024/10/02/managing-function-visibility-in-rust%f0%9f%a6%80-with-pub-a-simple-guide/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.