Skip to main content

Call

Struct Call 

Source
pub struct Call<'a> {
    pub root: &'a Path,
    pub start_dir: &'a Path,
    pub matched: &'a [String],
    pub config_files: &'a [PathBuf],
    pub pins: &'a BTreeMap<String, String>,
    pub args: &'a [OsString],
    pub verb: Verb,
    pub reason: SelectionReason,
    pub score: u32,
    pub files: &'a Declared,
}
Expand description

Everything one call needs that a plugin cannot work out for itself.

A borrowed view of the run’s own state, assembled at the call site: the plugin reads it through the ABI, and nothing here is copied for the host’s own benefit.

Fields§

§root: &'a Path

Project root: where the command runs unless the answer names a cwd of its own.

§start_dir: &'a Path

The directory the person ran pmpx from – not where the command will run.

§matched: &'a [String]

The files the plugin’s own detection matched.

§config_files: &'a [PathBuf]

The .pmpx.toml files that were read, nearest first.

§pins: &'a BTreeMap<String, String>

[plugin] pins from the project config.

§args: &'a [OsString]

The arguments the user typed.

§verb: Verb

Which verb this is.

§reason: SelectionReason

Why this plugin was selected.

§score: u32

The score it won with.

§files: &'a Declared

Reads the files the plugin declared, on demand – and refuses everything else.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Call<'a>

§

impl<'a> !Send for Call<'a>

§

impl<'a> !Sync for Call<'a>

§

impl<'a> !UnwindSafe for Call<'a>

§

impl<'a> Freeze for Call<'a>

§

impl<'a> Unpin for Call<'a>

§

impl<'a> UnsafeUnpin for Call<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.