Rollup merge of #40030 - matklad:stack-docs, r=alexcrichton
Clarify thread::Builder::stack_size docs Add two pieces of information: * the size is in bytes * the actual stack size might be bigger. Also change the example to use a more realistic value of 32 kilobytes. r? @steveklabnik
This commit is contained in:
commit
ef4d27d459
@ -235,7 +235,7 @@ pub use self::local::{LocalKey, LocalKeyState};
|
||||
pub struct Builder {
|
||||
// A name for the thread-to-be, for identification in panic messages
|
||||
name: Option<String>,
|
||||
// The size of the stack for the spawned thread
|
||||
// The size of the stack for the spawned thread in bytes
|
||||
stack_size: Option<usize>,
|
||||
}
|
||||
|
||||
@ -289,14 +289,17 @@ impl Builder {
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets the size of the stack for the new thread.
|
||||
/// Sets the size of the stack (in bytes) for the new thread.
|
||||
///
|
||||
/// The actual stack size may be greater than this value if
|
||||
/// the platform specifies minimal stack size.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use std::thread;
|
||||
///
|
||||
/// let builder = thread::Builder::new().stack_size(10);
|
||||
/// let builder = thread::Builder::new().stack_size(32 * 1024);
|
||||
/// ```
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub fn stack_size(mut self, size: usize) -> Builder {
|
||||
|
Loading…
Reference in New Issue
Block a user