Struct ZinitHandle 

pub struct ZinitHandle { /* private fields */ }

Synchronous handle for Rhai functions to use

Implementations

impl ZinitHandle

pub fn new() -> Result<Self>

Create a new handle that connects to the default server. Performs a health check (ping) to verify the connection is working.

Errors

Returns an error if:

• The default socket path cannot be determined
• The zinit server is not running or not reachable
• The ping request fails

pub fn new_unchecked() -> Result<Self>

Create a new handle without health check (for advanced use cases).

Use this when you want to defer the connection test or handle it manually. Call test_connection() afterwards to verify the connection.

pub fn with_socket<P: AsRef<Path>>(socket_path: P) -> Result<Self>

Create a new handle connecting to a specific socket path. Performs a health check (ping) to verify the connection is working.

Arguments

• socket_path - Path to the Unix socket file

Errors

Returns an error if:

• The zinit server is not running or not reachable at the specified path
• The ping request fails

pub fn with_socket_unchecked<P: AsRef<Path>>(socket_path: P) -> Result<Self>

Create a new handle connecting to a specific socket path without health check.

Use this when you want to defer the connection test or handle it manually. Call test_connection() afterwards to verify the connection.

pub fn with_client(client: ZinitClient) -> Result<Self>

Create a new handle with a specific client

pub fn with_log_level(self, level: LogLevel) -> Self

Set the log level for this handle

pub fn discover(&self) -> Result<Value>

Returns the OpenRPC specification

pub fn ping(&self) -> Result<PingResponse>

Ping the server and get version info

pub fn test_connection(&self) -> Result<String>

Test connection to the zinit server by performing a ping.

Returns Ok(version) if the connection is successful, or an error with a descriptive message if the connection fails.

This method is useful for explicitly verifying the connection after creating a handle with new_unchecked().

Examples

use zinit::ZinitHandle;

let handle = ZinitHandle::new_unchecked()?;
let version = handle.test_connection()?;
println!("Connected to zinit server version: {}", version);

pub fn shutdown(&self) -> Result<()>

Request daemon shutdown

pub fn reboot(&self) -> Result<()>

Reboot the system (Linux only, requires PID 1)

pub fn prepare_restart(&self) -> Result<PrepareRestartResult>

Prepare for hot restart by saving state to disk

pub fn service_set(&self, config: ServiceConfig) -> Result<AddServiceResult>

Create or update a service (always persisted)

pub fn service_get(&self, name: &str) -> Result<ServiceConfig>

Get service configuration

pub fn service_delete(&self, name: &str) -> Result<()>

Delete a service (stop and remove)

pub fn list(&self) -> Result<Vec<String>>

List all services

pub fn list_full(&self) -> Result<Vec<ServiceInfo>>

List all services with state information

pub fn start(&self, name: &str) -> Result<()>

Start a service

pub fn stop(&self, name: &str) -> Result<()>

Stop a service

pub fn restart(&self, name: &str) -> Result<()>

Restart a service

pub fn kill(&self, name: &str, signal: Option<&str>) -> Result<()>

Send a signal to a service

pub fn status(&self, name: &str) -> Result<ServiceStatus>

Get service status (simplified)

pub fn status_full(&self, name: &str) -> Result<ServiceStatusFull>

Get detailed service status with dependencies and uptime

pub fn stats(&self, name: &str) -> Result<ServiceStats>

Get CPU and memory statistics for a service

pub fn children(&self, name: &str) -> Result<ChildrenResponse>

Get child processes for a service

pub fn is_running(&self, name: &str) -> Result<bool>

Check if a service is currently running

pub fn why(&self, name: &str) -> Result<WhyBlocked>

Get information about why a service is blocked

pub fn tree(&self) -> Result<String>

Get the dependency tree as ASCII art

pub fn logs( &self, name: Option<&str>, lines: Option<usize>, ) -> Result<Vec<String>>

Get logs (simplified, returns strings)

pub fn logs_tail( &self, name: Option<&str>, lines: Option<usize>, ) -> Result<Vec<LogLine>>

Get structured log entries

pub fn logs_filter( &self, name: Option<&str>, stream: Option<&str>, since: Option<u64>, lines: Option<usize>, ) -> Result<Vec<LogLine>>

Get filtered log entries

pub fn debug_state(&self) -> Result<String>

Get full supervisor state for debugging

pub fn debug_process_tree(&self, name: &str) -> Result<String>

Get process tree for a service

pub fn xinet_set(&self, config: XinetConfig) -> Result<()>

Create or update an xinet proxy

pub fn xinet_delete(&self, name: &str) -> Result<()>

Delete an xinet proxy

pub fn xinet_list(&self) -> Result<Vec<String>>

List all xinet proxy names

pub fn xinet_status(&self, name: &str) -> Result<XinetStatus>

Get xinet proxy status (simplified)

pub fn xinet_status_all(&self) -> Result<Vec<XinetStatusFull>>

Get status of all xinet proxies

Trait Implementations

impl Clone for ZinitHandle

fn clone(&self) -> ZinitHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.