rust
/
nomicon
mirror of https://github.com/rust-lang/nomicon
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update to 2024 edition

Browse Source
pull/481/head
printfn 1 month ago
parent 8f5c7322b6
commit 60ed8f3bb9
7 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File

2
.github/workflows/main.yml vendored
Unescape View File

@ -4,7 +4,7 @@ on:
merge_group: merge_group:
env: env:
MDBOOK_VERSION: 0.4.40 MDBOOK_VERSION: 0.4.45
jobs: jobs:
test: test:

2
book.toml
Unescape View File

@ -32,4 +32,4 @@ git-repository-url = "https://github.com/rust-lang/nomicon"
"./arc.html" = "./arc-mutex/arc.html" "./arc.html" = "./arc-mutex/arc.html"
[rust] [rust]
edition = "2021" edition = "2024"

2
src/beneath-std.md
Unescape View File

@ -53,7 +53,7 @@ use core::ffi::{c_char, c_int};
use core::panic::PanicInfo; use core::panic::PanicInfo;
// Entry point for this program. // Entry point for this program.
#[no_mangle] // ensure that this symbol is included in the output as `main` #[unsafe(no_mangle)] // ensure that this symbol is included in the output as `main`
extern "C" fn main(_argc: c_int, _argv: *const *const c_char) -> c_int { extern "C" fn main(_argc: c_int, _argv: *const *const c_char) -> c_int {
0 0
} }

42
src/ffi.md
Unescape View File

@ -31,7 +31,7 @@ compile if snappy is installed:
use libc::size_t; use libc::size_t;
#[link(name = "snappy")] #[link(name = "snappy")]
extern { unsafe extern "C" {
fn snappy_max_compressed_length(source_length: size_t) -> size_t; fn snappy_max_compressed_length(source_length: size_t) -> size_t;
} }
@ -64,7 +64,7 @@ The `extern` block can be extended to cover the entire snappy API:
use libc::{c_int, size_t}; use libc::{c_int, size_t};
#[link(name = "snappy")] #[link(name = "snappy")]
extern { unsafe extern {
fn snappy_compress(input: *const u8, fn snappy_compress(input: *const u8,
input_length: size_t, input_length: size_t,
compressed: *mut u8, compressed: *mut u8,
@ -251,7 +251,7 @@ First, we assume you have a lib crate named as `rust_from_c`.
`lib.rs` should have Rust code as following: `lib.rs` should have Rust code as following:
```rust ```rust
#[no_mangle] #[unsafe(no_mangle)]
pub extern "C" fn hello_from_rust() { pub extern "C" fn hello_from_rust() {
println!("Hello from Rust!"); println!("Hello from Rust!");
} }
@ -331,7 +331,7 @@ extern fn callback(a: i32) {
} }
#[link(name = "extlib")] #[link(name = "extlib")]
extern { unsafe extern {
fn register_callback(cb: extern fn(i32)) -> i32; fn register_callback(cb: extern fn(i32)) -> i32;
fn trigger_callback(); fn trigger_callback();
} }
@ -383,7 +383,7 @@ struct RustObject {
// Other members... // Other members...
} }
extern "C" fn callback(target: *mut RustObject, a: i32) { unsafe extern "C" fn callback(target: *mut RustObject, a: i32) {
println!("I'm called from C with value {0}", a); println!("I'm called from C with value {0}", a);
unsafe { unsafe {
// Update the value in RustObject with the value received from the callback: // Update the value in RustObject with the value received from the callback:
@ -392,9 +392,9 @@ extern "C" fn callback(target: *mut RustObject, a: i32) {
} }
#[link(name = "extlib")] #[link(name = "extlib")]
extern { unsafe extern {
fn register_callback(target: *mut RustObject, fn register_callback(target: *mut RustObject,
cb: extern fn(*mut RustObject, i32)) -> i32; cb: unsafe extern fn(*mut RustObject, i32)) -> i32;
fn trigger_callback(); fn trigger_callback();
} }
@ -523,7 +523,7 @@ blocks with the `static` keyword:
<!-- ignore: requires libc crate --> <!-- ignore: requires libc crate -->
```rust,ignore ```rust,ignore
#[link(name = "readline")] #[link(name = "readline")]
extern { unsafe extern {
static rl_readline_version: libc::c_int; static rl_readline_version: libc::c_int;
} }
@ -543,7 +543,7 @@ use std::ffi::CString;
use std::ptr; use std::ptr;
#[link(name = "readline")] #[link(name = "readline")]
extern { unsafe extern {
static mut rl_prompt: *const libc::c_char; static mut rl_prompt: *const libc::c_char;
} }
@ -573,7 +573,7 @@ conventions. Rust provides a way to tell the compiler which convention to use:
#[cfg(all(target_os = "win32", target_arch = "x86"))] #[cfg(all(target_os = "win32", target_arch = "x86"))]
#[link(name = "kernel32")] #[link(name = "kernel32")]
#[allow(non_snake_case)] #[allow(non_snake_case)]
extern "stdcall" { unsafe extern "stdcall" {
fn SetEnvironmentVariableA(n: *const u8, v: *const u8) -> libc::c_int; fn SetEnvironmentVariableA(n: *const u8, v: *const u8) -> libc::c_int;
} }
# fn main() { } # fn main() { }
@ -635,7 +635,7 @@ In C, functions can be 'variadic', meaning they accept a variable number of argu
be achieved in Rust by specifying `...` within the argument list of a foreign function declaration: be achieved in Rust by specifying `...` within the argument list of a foreign function declaration:
```no_run ```no_run
extern { unsafe extern {
fn foo(x: i32, ...); fn foo(x: i32, ...);
} }
@ -685,7 +685,7 @@ we have function pointers flying across the FFI boundary in both directions.
use libc::c_int; use libc::c_int;
# #[cfg(hidden)] # #[cfg(hidden)]
extern "C" { unsafe extern "C" {
/// Registers the callback. /// Registers the callback.
fn register(cb: Option<extern "C" fn(Option<extern "C" fn(c_int) -> c_int>, c_int) -> c_int>); fn register(cb: Option<extern "C" fn(Option<extern "C" fn(c_int) -> c_int>, c_int) -> c_int>);
} }
@ -750,8 +750,8 @@ mechanisms (notably C++'s `try`/`catch`).
<!-- ignore: using unstable feature --> <!-- ignore: using unstable feature -->
```rust,ignore ```rust,ignore
#[no_mangle] #[unsafe(no_mangle)]
extern "C-unwind" fn example() { unsafe extern "C-unwind" fn example() {
panic!("Uh oh"); panic!("Uh oh");
} }
``` ```
@ -780,13 +780,13 @@ If the C++ frames have objects, their destructors will be called.
<!-- ignore: using unstable feature --> <!-- ignore: using unstable feature -->
```rust,ignore ```rust,ignore
#[link(...)] #[link(...)]
extern "C-unwind" { unsafe extern "C-unwind" {
// A C++ function that may throw an exception // A C++ function that may throw an exception
fn may_throw(); fn may_throw();
} }
#[no_mangle] #[unsafe(no_mangle)]
extern "C-unwind" fn rust_passthrough() { unsafe extern "C-unwind" fn rust_passthrough() {
let b = Box::new(5); let b = Box::new(5);
unsafe { may_throw(); } unsafe { may_throw(); }
println!("{:?}", &b); println!("{:?}", &b);
@ -816,7 +816,7 @@ will be printed.
### `panic` can be stopped at an ABI boundary ### `panic` can be stopped at an ABI boundary
```rust ```rust
#[no_mangle] #[unsafe(no_mangle)]
extern "C" fn assert_nonzero(input: u32) { extern "C" fn assert_nonzero(input: u32) {
assert!(input != 0) assert!(input != 0)
} }
@ -833,7 +833,7 @@ process if it panics, you must use [`catch_unwind`]:
```rust ```rust
use std::panic::catch_unwind; use std::panic::catch_unwind;
#[no_mangle] #[unsafe(no_mangle)]
pub extern "C" fn oh_no() -> i32 { pub extern "C" fn oh_no() -> i32 {
let result = catch_unwind(|| { let result = catch_unwind(|| {
panic!("Oops!"); panic!("Oops!");
@ -867,7 +867,7 @@ We can represent this in Rust with the `c_void` type:
<!-- ignore: requires libc crate --> <!-- ignore: requires libc crate -->
```rust,ignore ```rust,ignore
extern "C" { unsafe extern "C" {
pub fn foo(arg: *mut libc::c_void); pub fn foo(arg: *mut libc::c_void);
pub fn bar(arg: *mut libc::c_void); pub fn bar(arg: *mut libc::c_void);
} }
@ -902,7 +902,7 @@ pub struct Bar {
core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>, core::marker::PhantomData<(*mut u8, core::marker::PhantomPinned)>,
} }
extern "C" { unsafe extern "C" {
pub fn foo(arg: *mut Foo); pub fn foo(arg: *mut Foo);
pub fn bar(arg: *mut Bar); pub fn bar(arg: *mut Bar);
} }

2
src/intro.md
Unescape View File

@ -39,7 +39,7 @@ Topics that are within the scope of this book include: the meaning of (un)safety
The Rustonomicon is not a place to exhaustively describe the semantics and guarantees of every single API in the standard library, nor is it a place to exhaustively describe every feature of Rust. The Rustonomicon is not a place to exhaustively describe the semantics and guarantees of every single API in the standard library, nor is it a place to exhaustively describe every feature of Rust.
Unless otherwise noted, Rust code in this book uses the Rust 2021 edition. Unless otherwise noted, Rust code in this book uses the Rust 2024 edition.
[trpl]: ../book/index.html [trpl]: ../book/index.html
[ref]: ../reference/index.html [ref]: ../reference/index.html

2
src/other-reprs.md
Unescape View File

@ -145,7 +145,7 @@ and it will become a hard error.
`repr(packed)/repr(packed(n))` is not to be used lightly. Unless you have `repr(packed)/repr(packed(n))` is not to be used lightly. Unless you have
extreme requirements, this should not be used. extreme requirements, this should not be used.
This repr is a modifier on `repr(C)` and `repr(Rust)`. For FFI compatibilty This repr is a modifier on `repr(C)` and `repr(Rust)`. For FFI compatibility
you most likely always want to be explicit: `repr(C, packed)`. you most likely always want to be explicit: `repr(C, packed)`.
## repr(align(n)) ## repr(align(n))

4
src/send-and-sync.md
Unescape View File

@ -89,7 +89,7 @@ to the heap.
# pub use ::std::os::raw::{c_int, c_void}; # pub use ::std::os::raw::{c_int, c_void};
# #[allow(non_camel_case_types)] # #[allow(non_camel_case_types)]
# pub type size_t = usize; # pub type size_t = usize;
# extern "C" { pub fn posix_memalign(memptr: *mut *mut c_void, align: size_t, size: size_t) -> c_int; } # unsafe extern "C" { pub fn posix_memalign(memptr: *mut *mut c_void, align: size_t, size: size_t) -> c_int; }
# } # }
use std::{ use std::{
mem::{align_of, size_of}, mem::{align_of, size_of},
@ -225,7 +225,7 @@ allocation done on another thread. We can check this is true in the docs for
# struct Carton<T>(std::ptr::NonNull<T>); # struct Carton<T>(std::ptr::NonNull<T>);
# mod libc { # mod libc {
# pub use ::std::os::raw::c_void; # pub use ::std::os::raw::c_void;
# extern "C" { pub fn free(p: *mut c_void); } # unsafe extern "C" { pub fn free(p: *mut c_void); }
# } # }
impl<T> Drop for Carton<T> { impl<T> Drop for Carton<T> {
fn drop(&mut self) { fn drop(&mut self) {

Write Preview
Loading…
Cancel
Save