Struct heph_rt::spawn::options::ActorOptions

pub struct ActorOptions { /* private fields */ }

Options for spawning an Actor.

Examples

Using the default options.

use heph_rt::spawn::ActorOptions;

let opts = ActorOptions::default();

Giving an actor a high priority.

use heph_rt::spawn::options::{ActorOptions, Priority};

let opts = ActorOptions::default().with_priority(Priority::HIGH);

Implementations

impl ActorOptions

pub const fn priority(&self) -> Priority

Returns the priority set in the options.

pub const fn with_priority(self, priority: Priority) -> Self

Set the scheduling priority.

pub const fn is_ready(&self) -> bool

Returns true if the actor is ready to run when spawned.

See mark_ready for more information.

pub const fn mark_ready(self, ready: bool) -> Self

This option will marks the actor as ready to run (or not) when spawned.

By default newly spawned actors will be considered to be ready to run once they are spawned. However some actors might not want to run immediately and wait for an external event before running. Such an external event can for example be a TcpStream becoming ready to read or write.

Trait Implementations

impl Clone for ActorOptions

fn clone(&self) -> ActorOptions

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActorOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ActorOptions

fn default() -> ActorOptions

Returns the “default value” for a type.