Struct LaunchAgent 

pub struct LaunchAgent {
    pub label: String,
    pub program_arguments: Vec<String>,
    pub standard_out_path: PathBuf,
    pub standard_error_path: PathBuf,
    pub keep_alive: bool,
    pub run_at_load: bool,
    pub process_type: ProcessType,
}

Launch Agent configuration.

A Launch Agent is a macOS mechanism for automatically starting user-level processes at login or in response to specific events. Launch Agents are described using plist files, which are placed in the ~/Library/LaunchAgents directory.

Each agent can be configured to start automatically, restart on failure, redirect output, and pass arguments to the launched process. Agents are managed using the launchctl utility.

More information: [https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html](Apple Developer Documentation)

Fields

label: String

program_arguments: Vec<String>

standard_out_path: PathBuf

standard_error_path: PathBuf

keep_alive: bool

run_at_load: bool

process_type: ProcessType

Implementations

impl LaunchAgent

pub fn new(label: &str) -> Self

Create a new Launch Agent configuration.

pub fn exists(label: &str) -> bool

Check if a Launch Agent configuration exists.

pub fn from_file(label: &str) -> Result<Self, LaunchAgentError>

Loads a Launch Agent configuration from ~/Library/LaunchAgents by agent label.

impl LaunchAgent

pub fn write(&self) -> Result<(), LaunchAgentError>

Writes the Launch Agent configuration to the current user’s LaunchAgents directory.

pub fn remove(&self) -> Result<(), LaunchAgentError>

Removes the Launch Agent configuration from the current user’s LaunchAgents directory.

pub fn path(&self) -> PathBuf

Returns the path to the Launch Agent configuration file for the given label.

Trait Implementations

impl Clone for LaunchAgent

fn clone(&self) -> LaunchAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for LaunchAgent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl LaunchControllable for LaunchAgent

fn bootstrap(&self) -> LaunchctlResult<()>

Bootstrap the launch agent.

fn boot_out(&self) -> LaunchctlResult<()>

Boot out the launch agent. It means not only stop, but also deactivate the launch agent.

fn is_running(&self) -> LaunchctlResult<bool>

Check if the launch agent is running.

impl Serialize for LaunchAgent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.