Struct tetsy_runtime::TokioRuntimeBuilder [−][src]
Builds a compatibility runtime with custom configuration values.
This runtime is compatible with code using both the current release version
of tokio
(0.1) and with legacy code using tokio
0.1.
Methods can be chained in order to set the configuration values. The
Runtime is constructed by calling build
.
New instances of Builder
are obtained via Builder::new
.
See function level documentation for details on the various configuration settings.
Examples
use tokio_compat::runtime::Builder; use tokio_timer_02::clock::Clock; fn main() { // build Runtime let runtime = Builder::new() .clock(Clock::system()) .core_threads(4) .name_prefix("my-custom-name-") .stack_size(3 * 1024 * 1024) .build() .unwrap(); // use runtime ... }
Implementations
impl Builder
[src]
pub fn new() -> Builder
[src]
Returns a new runtime builder initialized with default configuration values.
Configuration methods can be chained on the return value.
pub fn clock(&mut self, clock: Clock) -> &mut Builder
[src]
Set the Clock
instance that will be used by the runtime’s legacy timer.
pub fn core_threads(&mut self, val: usize) -> &mut Builder
[src]
Set the maximum number of worker threads for the Runtime
’s thread pool.
This must be a number between 1 and 32,768 though it is advised to keep this value on the smaller side.
The default value is the number of cores available to the system.
Examples
let rt = runtime::Builder::new() .core_threads(4) .build() .unwrap();
pub fn name_prefix<S>(&mut self, val: S) -> &mut Builder where
S: Into<String>,
[src]
S: Into<String>,
Set name prefix of threads spawned by the Runtime
’s thread pool.
Thread name prefix is used for generating thread names. For example, if
prefix is my-pool-
, then threads in the pool will get names like
my-pool-1
etc.
The default prefix is “tokio-runtime-worker-”.
Examples
let rt = runtime::Builder::new() .name_prefix("my-pool-") .build();
pub fn stack_size(&mut self, val: usize) -> &mut Builder
[src]
Set the stack size (in bytes) for worker threads.
The actual stack size may be greater than this value if the platform specifies minimal stack size.
The default stack size for spawned threads is 2 MiB, though this particular stack size is subject to change in the future.
Examples
let rt = runtime::Builder::new() .stack_size(32 * 1024) .build();
pub fn build(&mut self) -> Result<Runtime, Error>
[src]
Create the configured Runtime
.
The returned ThreadPool
instance is ready to spawn tasks.
Examples
let runtime = Builder::new().build().unwrap(); // ... call runtime.run(...)
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl !UnwindSafe for Builder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,