Rust modules: Difference between revisions

From wikinotes
No edit summary
Line 1: Line 1:
Modules are rust libraries.<br>
Modules are rust libraries.<br>
The <code>std::prelude</code> module is included in the scope of every program.
The <code>std::prelude</code> module is included in the scope of every program.
= Documentation =
<blockquote>
{| class="wikitable"
|-
| cargo book: package layout || https://doc.rust-lang.org/cargo/guide/project-layout.html
|-
|}
</blockquote><!-- Documentation -->


= Entrypoint =
= Entrypoint =

Revision as of 02:28, 8 February 2023

Modules are rust libraries.
The std::prelude module is included in the scope of every program.

Documentation

cargo book: package layout https://doc.rust-lang.org/cargo/guide/project-layout.html

Entrypoint

For modules to be compiled, they must be used (however indirectly)
from either your crate's main.rs or lib.rs.

Naming/Paths

Module names govern where they can be found within the filesystem.
Module locations are based on where they are defined

# from the rust book:
backyard
├── Cargo.lock
├── Cargo.toml
└── src
    ├── garden
    │   └── vegetables.rs
    ├── garden.rs
    └── main.rs

The module foo's code could be

  • src/foo.rs
  • src/foo/mod.rs

Imports

use std::io;                      // merges objects from namespace into your own
use std::fs::File;                // import 'File' only into current namespace
use std::fs::{File, DirBuilder};  // import multiple types/functions into current namespace

std::io::stdin()                  // you also can access objects directly from their namespace without `use`

Access Control

By default, a module's code is public to itself and it's children,
but private to it's parents and/or callers.

pub mod house {
    pub mod livingroom {
        // ...
    }
    mod bedroom {
        // ...
    }
}