Enum HookShell 

#[non_exhaustive]
pub enum HookShell {
    Bash,
    Sh,
    PowerShell,
}

Shell type for hook execution in update payloads.

Determines which shell interpreter and fail-early settings are used.

Marked #[non_exhaustive] because additional shell types (e.g. fish, zsh) may be added in future releases. Downstream code must include a wildcard arm when matching on this enum.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bash

Bash shell with set -euo pipefail

Sh

POSIX sh with set -eu

PowerShell

PowerShell with $ErrorActionPreference = 'Stop'

Implementations

impl HookShell

pub const fn as_str(&self) -> &'static str

Returns the string representation of the shell type.

pub fn local_executable(self) -> &'static str

Shell executable for the local machine (auto-detects platform).

PowerShell uses pwsh (PowerShell Core) on Linux/macOS because powershell (Windows PowerShell 5.1) does not exist there.

pub fn remote_executable(self, remote_is_windows: bool) -> &'static str

Shell executable for a remote host.

Pass true when the remote host is Windows; false for Linux, macOS, or any other non-Windows OS. SSH executors use this method because local_executable() reflects the agent machine’s OS, not the target’s.

PowerShell: Windows → powershell, non-Windows → pwsh.

pub fn flag(self) -> &'static str

The argument flag for this shell (e.g., -c or -Command).

Trait Implementations

impl Clone for HookShell

fn clone(&self) -> HookShell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HookShell

impl Debug for HookShell

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

Formats the value using the given formatter.

impl Default for HookShell

fn default() -> HookShell

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookShell

fn deserialize<__D>( __deserializer: __D, ) -> Result<HookShell, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HookShell

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

Formats the value using the given formatter.

impl Eq for HookShell

impl FromStr for HookShell

type Err = ParseHookShellError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HookShell, <HookShell as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for HookShell

fn eq(&self, other: &HookShell) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for HookShell

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HookShell