Struct proto_pdk::ShimConfig

pub struct ShimConfig {
    pub bin_path: Option<PathBuf>,
    pub parent_bin: Option<String>,
    pub before_args: Option<String>,
    pub after_args: Option<String>,
}

Configuration for individual shim files.

Fields

bin_path: Option<PathBuf>

Relative path from the tool directory to the binary to execute.

parent_bin: Option<String>

Name of a parent binary that’s required for this shim to work. For example, npm requires node.

before_args: Option<String>

Custom args to prepend to user-provided args.

after_args: Option<String>

Custom args to append to user-provided args.

Implementations

impl ShimConfig

pub fn global_with_alt_bin<B>(bin_path: B) -> ShimConfigwhere B: AsRef<OsStr>,

Create a global shim that executes the parent tool, but uses the provided binary as the entry point.

pub fn global_with_sub_command<A>(args: A) -> ShimConfigwhere A: AsRef<str>,

Create a global shim that executes the parent tool, but prefixes the user-provided arguments with the provided arguments (typically a sub-command).

pub fn local<B>(bin_path: B) -> ShimConfigwhere B: AsRef<OsStr>,

Create a local shim that executes the provided binary.

pub fn local_with_parent<B, P>(bin_path: B, parent: P) -> ShimConfigwhere B: AsRef<OsStr>, P: AsRef<str>,

Create a local shim that executes the provided binary through the context of the configured parent.

Trait Implementations

impl Clone for ShimConfig

fn clone(&self) -> ShimConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShimConfig

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

Formats the value using the given formatter.

impl Default for ShimConfig

fn default() -> ShimConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShimConfigwhere ShimConfig: Default,

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShimConfig

fn eq(&self, other: &ShimConfig) -> 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 ShimConfig

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 Eq for ShimConfig

impl StructuralEq for ShimConfig

impl StructuralPartialEq for ShimConfig