Struct proto_pdk_api::ExecutableConfig

pub struct ExecutableConfig {
    pub exe_path: Option<PathBuf>,
    pub exe_link_path: Option<PathBuf>,
    pub no_bin: bool,
    pub no_shim: bool,
    pub parent_exe_name: Option<String>,
    pub shim_before_args: Option<StringOrVec>,
    pub shim_after_args: Option<StringOrVec>,
    pub shim_env_vars: Option<FxHashMap<String, String>>,
}

Configuration for generated shim and symlinked binary files.

Fields

exe_path: Option<PathBuf>

The file to execute, relative from the tool directory. Does not support virtual paths.

The following scenarios are powered by this field:

• Is the primary executable.
• For primary and secondary bins, the source file to be symlinked, and the extension to use for the symlink file itself.
• For primary shim, this field is ignored.
• For secondary shims, the file to execute.

exe_link_path: Option<PathBuf>

The executable path to use for symlinking binaries instead of exe_path. This should only be used when exe_path is a non-standard executable.

no_bin: bool

Do not symlink a binary in ~/.proto/bin.

no_shim: bool

Do not generate a shim in ~/.proto/shims.

parent_exe_name: Option<String>

The parent executable name required to execute the local executable path.

shim_before_args: Option<StringOrVec>

Custom args to prepend to user-provided args within the generated shim.

shim_after_args: Option<StringOrVec>

Custom args to append to user-provided args within the generated shim.

shim_env_vars: Option<FxHashMap<String, String>>

Custom environment variables to set when executing the shim.

Implementations

impl ExecutableConfig

pub fn new<T: AsRef<str>>(exe_path: T) -> Self

pub fn with_parent<T: AsRef<str>, P: AsRef<str>>( exe_path: T, parent_exe: P ) -> Self

Trait Implementations

impl Clone for ExecutableConfig

fn clone(&self) -> ExecutableConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutableConfig

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

Formats the value using the given formatter.

impl Default for ExecutableConfig

fn default() -> ExecutableConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecutableConfig

where ExecutableConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExecutableConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ExecutableConfig

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 ExecutableConfig