Struct SupervisorOptions 

pub struct SupervisorOptions { /* private fields */ }

Options used to configure a Supervisor.

Implementations

impl SupervisorOptions

pub const fn new() -> Self

Constructs a new instance of SupervisorOptions with the default values.

Examples found in repository

examples/supervisor.rs (line 40)

    async fn start(&self) -> Result<Pid, ExitReason> {
        // Spawn two instances of `MyServer` with their own unique ids.
        let children = [
            MyServer::new().child_spec().id("server1"),
            MyServer::new().child_spec().id("server2"),
        ];

        // Restart only the terminated child.
        Supervisor::with_children(children)
            .strategy(SupervisionStrategy::OneForOne)
            .start_link(SupervisorOptions::new())
            .await
    }

examples/registry.rs (line 79)

    async fn start(&self) -> Result<Pid, ExitReason> {
        // Spawn a registry that will take care of registering 'MySpace'.
        let children = [
            Registry::new("space-registry")
                .with_start(|key| {
                    let RegistryKey::String(id) = key else {
                        panic!()
                    };

                    MySpace::new(id).start_link(GenServerOptions::new())
                })
                .with_shutdown(Shutdown::Infinity)
                .child_spec(RegistryOptions::new())
                .id("space-registry"),
            ChildSpec::new("test-registry")
                .start(move || async { Ok(Process::spawn(test_registry())) }),
        ];

        // Restart only the terminated child.
        Supervisor::with_children(children)
            .strategy(SupervisionStrategy::OneForOne)
            .start_link(SupervisorOptions::new())
            .await
    }

pub fn name<T: Into<String>>(self, name: T) -> Self

Specifies a name to register the Supervisor under.

pub fn timeout(self, timeout: Duration) -> Self

Specifies a timeout for the Supervisor init function.

Trait Implementations

impl Clone for SupervisorOptions

fn clone(&self) -> SupervisorOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupervisorOptions

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

Formats the value using the given formatter.

impl Default for SupervisorOptions

fn default() -> SupervisorOptions

Returns the “default value” for a type.

impl From<SupervisorOptions> for GenServerOptions

fn from(value: SupervisorOptions) -> Self

Converts to this type from the input type.