2020-12-25 14:16:02 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2021-02-09 09:07:07 +00:00
< title > cargo doc - Easy Rust< / title >
2021-07-17 16:29:15 +00:00
2020-12-25 14:16:02 +00:00
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2021-07-17 16:29:15 +00:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2020-12-25 14:16:02 +00:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-07-17 16:29:15 +00:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2020-12-25 14:16:02 +00:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2021-07-17 16:29:15 +00:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2020-12-25 14:16:02 +00:00
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
2021-07-17 16:29:15 +00:00
< / head >
2020-12-25 14:16:02 +00:00
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-07-17 16:29:15 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "Chapter_0.html" > < strong aria-hidden = "true" > 1.< / strong > Updates< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_1.html" > < strong aria-hidden = "true" > 2.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_2.html" > < strong aria-hidden = "true" > 3.< / strong > Who am I?< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_3.html" > < strong aria-hidden = "true" > 4.< / strong > Writing Rust in Easy English< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_4.html" > < strong aria-hidden = "true" > 5.< / strong > Rust Playground< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_5.html" > < strong aria-hidden = "true" > 6.< / strong > 🚧 and ⚠️< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_6.html" > < strong aria-hidden = "true" > 7.< / strong > Comments< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_7.html" > < strong aria-hidden = "true" > 8.< / strong > Types< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_8.html" > < strong aria-hidden = "true" > 9.< / strong > Type inference< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_9.html" > < strong aria-hidden = "true" > 10.< / strong > Printing 'hello, world!'< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_10.html" > < strong aria-hidden = "true" > 11.< / strong > Display and debug< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_11.html" > < strong aria-hidden = "true" > 12.< / strong > Mutability (changing)< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_12.html" > < strong aria-hidden = "true" > 13.< / strong > The stack, the heap, and pointers< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_13.html" > < strong aria-hidden = "true" > 14.< / strong > More about printing< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_14.html" > < strong aria-hidden = "true" > 15.< / strong > Strings< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_15.html" > < strong aria-hidden = "true" > 16.< / strong > const and static< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_16.html" > < strong aria-hidden = "true" > 17.< / strong > More on references< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_17.html" > < strong aria-hidden = "true" > 18.< / strong > Mutable references< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_18.html" > < strong aria-hidden = "true" > 19.< / strong > Giving references to functions< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_19.html" > < strong aria-hidden = "true" > 20.< / strong > Copy types< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_20.html" > < strong aria-hidden = "true" > 21.< / strong > Collection types< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_21.html" > < strong aria-hidden = "true" > 22.< / strong > Vectors< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_22.html" > < strong aria-hidden = "true" > 23.< / strong > Tuples< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_23.html" > < strong aria-hidden = "true" > 24.< / strong > Control flow< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_24.html" > < strong aria-hidden = "true" > 25.< / strong > Structs< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_25.html" > < strong aria-hidden = "true" > 26.< / strong > Enums< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_26.html" > < strong aria-hidden = "true" > 27.< / strong > Loops< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_27.html" > < strong aria-hidden = "true" > 28.< / strong > Implementing structs and enums< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_28.html" > < strong aria-hidden = "true" > 29.< / strong > Destructuring< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_29.html" > < strong aria-hidden = "true" > 30.< / strong > References and the dot operator< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_30.html" > < strong aria-hidden = "true" > 31.< / strong > Generics< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_31.html" > < strong aria-hidden = "true" > 32.< / strong > Option and Result< / a > < / li > < li class = "chapter-item expanded " > < a href = "Chapter_32.html" > < strong aria-h
2020-12-25 14:16:02 +00:00
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
2021-07-17 16:29:15 +00:00
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
2020-12-25 14:16:02 +00:00
< i class = "fa fa-search" > < / i >
< / button >
2021-07-17 16:29:15 +00:00
< / div >
2020-12-25 14:16:02 +00:00
< h1 class = "menu-title" > Easy Rust< / h1 >
< div class = "right-buttons" >
2021-07-17 16:29:15 +00:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2020-12-25 14:16:02 +00:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2021-07-17 16:29:15 +00:00
2020-12-25 14:16:02 +00:00
< / div >
< / div >
2021-07-17 16:29:15 +00:00
< div id = "search-wrapper" class = "hidden" >
2020-12-25 14:16:02 +00:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-05-23 04:18:41 +00:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2020-12-25 14:16:02 +00:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2021-02-24 06:13:19 +00:00
< h2 id = "cargo-doc" > < a class = "header" href = "#cargo-doc" > cargo doc< / a > < / h2 >
2021-02-09 09:07:07 +00:00
< p > You might have noticed that Rust documentation always looks almost the same. On the left side you can see < code > struct< / code > s and < code > trait< / code > s, code examples are on the right, etc. This is because you can automatically make documentation just by typing < code > cargo doc< / code > .< / p >
< p > Even making a project with nothing can help you learn about traits in Rust. For example, here are two structs that do almost nothing, and a < code > fn main()< / code > that also does nothing.< / p >
< pre > < pre class = "playground" > < code class = "language-rust" > struct DoesNothing {}
struct PrintThing {}
2020-12-25 14:16:02 +00:00
2021-02-09 09:07:07 +00:00
impl PrintThing {
fn prints_something() {
println!(" I am printing something" );
2020-12-25 14:16:02 +00:00
}
}
2021-02-09 09:07:07 +00:00
fn main() {}
2020-12-25 14:16:02 +00:00
< / code > < / pre > < / pre >
2021-02-09 09:07:07 +00:00
< p > But if you type < code > cargo doc --open< / code > , you can see a lot more information than you expected. First it shows you this:< / p >
< pre > < code class = "language-text" > Crate rust_book
2020-12-25 14:16:02 +00:00
2021-02-09 09:07:07 +00:00
Structs
DoesNothing
PrintThing
2020-12-25 14:16:02 +00:00
2021-02-09 09:07:07 +00:00
Functions
main
< / code > < / pre >
< p > But if you click on one of the structs, it will show you a lot of traits that you didn't think were there:< / p >
< pre > < code class = "language-text" > Struct rust_book::DoesNothing
[+] Show declaration
Auto Trait Implementations
impl RefUnwindSafe for DoesNothing
impl Send for DoesNothing
impl Sync for DoesNothing
impl Unpin for DoesNothing
impl UnwindSafe for DoesNothing
Blanket Implementations
impl< T> Any for T
where
T: 'static + ?Sized,
[src]
[+]
impl< T> Borrow< T> for T
where
T: ?Sized,
[src]
[+]
impl< T> BorrowMut< T> for T
where
T: ?Sized,
[src]
[+]
impl< T> From< T> for T
[src]
[+]
impl< T, U> Into< U> for T
where
U: From< T> ,
[src]
[+]
impl< T, U> TryFrom< U> for T
where
U: Into< T> ,
[src]
[+]
impl< T, U> TryInto< U> for T
where
U: TryFrom< T> ,
< / code > < / pre >
< p > This is because of all the traits that Rust automatically makes for every type.< / p >
< p > Then if we add some documentation comments you can see them when you type < code > cargo doc< / code > .< / p >
< pre > < pre class = "playground" > < code class = "language-rust" > /// This is a struct that does nothing
struct DoesNothing {}
/// This struct only has one method.
struct PrintThing {}
/// It just prints the same message.
impl PrintThing {
fn prints_something() {
println!(" I am printing something" );
}
2020-12-25 14:16:02 +00:00
}
2021-02-09 09:07:07 +00:00
fn main() {}
2020-12-25 14:16:02 +00:00
< / code > < / pre > < / pre >
2021-02-09 09:07:07 +00:00
< p > Now it will print:< / p >
< pre > < code class = "language-text" > Crate rust_book
Structs
DoesNothing This is a struct that does nothing
PrintThing This struct only has one method.
Functions
main
< / code > < / pre >
< p > < code > cargo doc< / code > is very nice when you use a lot of other people's crates. Because these crates are all on different websites, it can take some time to search them all. But if you use < code > cargo doc< / code > , you will have them all in the same place on your hard drive.< / p >
2020-12-25 14:16:02 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-07-17 16:29:15 +00:00
< a rel = "prev" href = "Chapter_64.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2020-12-25 14:16:02 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-07-17 16:29:15 +00:00
< a rel = "next" href = "Chapter_66.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2020-12-25 14:16:02 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-07-17 16:29:15 +00:00
< a rel = "prev" href = "Chapter_64.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2020-12-25 14:16:02 +00:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-07-17 16:29:15 +00:00
< a rel = "next" href = "Chapter_66.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2020-12-25 14:16:02 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-07-17 16:29:15 +00:00
< / nav >
2020-12-25 14:16:02 +00:00
< / div >
2021-07-17 16:29:15 +00:00
< script type = "text/javascript" >
2020-12-25 14:16:02 +00:00
window.playground_copyable = true;
< / script >
2021-07-17 16:29:15 +00:00
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
2020-12-25 14:16:02 +00:00
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
