Struct PreConnectStep 

#[non_exhaustive]
pub struct PreConnectStep {
    pub command: String,
    pub save_output_to: Option<String>,
    pub timeout_secs: Option<u32>,
    pub required: bool,
}

One pre-connect command.

The command string is handed to sh -c so users can compose pipes / redirections without us shipping a parser. Stdout is captured (trimmed of trailing whitespace) and, when save_output_to is set, stored under that key in the pre-connect variable map.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

command: String

Shell command line. Run via sh -c.

save_output_to: Option<String>

When set, the trimmed stdout of command is stored under this key in the variable map exposed to the rest of the connection params via ${preconnect:NAME} placeholders.

timeout_secs: Option<u32>

Time budget for this step. Defaults to 30 seconds. The whole pre-connect sequence is capped at the sum of its steps’ timeouts so a wedged kubectl call cannot freeze the UI.

required: bool

When true, a non-zero exit aborts the entire connection open. When false, the failure is logged and the sequence continues to the next step. Defaults to true.

Implementations

impl PreConnectStep

pub fn new(command: impl Into<String>) -> Self

Build a step from the bare command line. Convenience for tests and any future config-tooling that wants to assemble a step without going through serde.

pub fn with_save_output_to(self, key: impl Into<String>) -> Self

pub const fn with_timeout_secs(self, secs: u32) -> Self

pub const fn with_required(self, required: bool) -> Self

Trait Implementations

impl Clone for PreConnectStep

fn clone(&self) -> PreConnectStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreConnectStep

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

Formats the value using the given formatter.

impl Default for PreConnectStep

fn default() -> PreConnectStep

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PreConnectStep

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PreConnectStep

impl PartialEq for PreConnectStep

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PreConnectStep

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PreConnectStep