Struct hydra::GenServerOptions

pub struct GenServerOptions { /* private fields */ }

Options used to configure a GenServer.

Implementations

impl GenServerOptions

pub const fn new() -> Self

Constructs a new instance of GenServerOptions with the default values.

Examples found in repository

examples/supervisor.rs (line 67)

    pub fn child_spec(self) -> ChildSpec {
        ChildSpec::new("MyServer")
            .start(move || MyServer::start_link(MyServer, GenServerOptions::new()))
    }

examples/application.rs (line 63)

    async fn start(&self) -> Result<Pid, ExitReason> {
        let pid = Stack::with_entries(vec!["hello", "world"])
            .start_link(GenServerOptions::new())
            .await
            .expect("Failed to start stack!");

        let result = Stack::call(pid, StackMessage::Pop, None)
            .await
            .expect("Stack call failed!");

        tracing::info!("{:?}", result);

        Stack::cast(pid, StackMessage::Push(String::from("rust")));

        let result = Stack::call(pid, StackMessage::Pop, None)
            .await
            .expect("Stack call failed!");

        tracing::info!("{:?}", result);

        // Otherwise, the application will run forever waiting for Stack to terminate.
        Stack::stop(pid, ExitReason::Normal, None).await?;

        Ok(pid)
    }

examples/registry.rs (line 67)

    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 GenServer under.

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

Specifies a timeout for the GenServer init function.

Trait Implementations

impl Clone for GenServerOptions

fn clone(&self) -> GenServerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenServerOptions

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

Formats the value using the given formatter.

impl Default for GenServerOptions

fn default() -> GenServerOptions

Returns the “default value” for a type.

impl From<RegistryOptions> for GenServerOptions

fn from(value: RegistryOptions) -> Self

Converts to this type from the input type.

impl From<SupervisorOptions> for GenServerOptions

fn from(value: SupervisorOptions) -> Self

Converts to this type from the input type.