rust-lang-nursery/nomicon

Name: nomicon

Owner: rust-lang-nursery

Description: The Dark Arts of Advanced and Unsafe Rust Programming

Created: 2017-03-02 23:49:34.0

Updated: 2018-05-10 17:04:43.0

Pushed: 2018-05-08 15:40:03.0

Homepage: https://doc.rust-lang.org/nomicon/

Size: 933

Language: null

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

The Rustonomicon

The Dark Arts of Advanced and Unsafe Rust Programming

Nicknamed “the Nomicon.”

NOTE: This is a draft document, and may contain serious errors

Instead of the programs I had hoped for, there came only a shuddering blackness and ineffable loneliness; and I saw at last a fearful truth which no one had ever dared to breathe before ? the unwhisperable secret of secrets ? The fact that this language of stone and stridor is not a sentient perpetuation of Rust as London is of Old London and Paris of Old Paris, but that it is in fact quite unsafe, its sprawling body imperfectly embalmed and infested with queer animate things which have nothing to do with it as it was in compilation.

This book digs into all the awful details that are necessary to understand in order to write correct Unsafe Rust programs. Due to the nature of this problem, it may lead to unleashing untold horrors that shatter your psyche into a billion infinitesimal fragments of despair.

Requirements

Building the Nomicon requires mdBook. To get it:

rgo install mdbook

Building

To build the Nomicon:

book build

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

refox book/index.html                       # Linux
en -a "Firefox" book/index.html             # OS X
art-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
art firefox.exe .\book\index.html           # Windows (Cmd)

Chrome:

ogle-chrome book/index.html                 # Linux
en -a "Google Chrome" book/index.html       # OS X
art-Process "chrome.exe" .\book\index.html  # Windows (PowerShell)
art chrome.exe .\book\index.html            # Windows (Cmd)

To run the tests:

book test

Contributing

Given that the Nomicon is still in a draft state, we'd love your help! Please feel free to open issues about anything, and send in PRs for things you'd like to fix or change. If your change is large, please open an issue first, so we can make sure that it's something we'd accept before you go through the work of getting a PR together.