Struct AppContext 

#[non_exhaustive]
pub struct AppContext {
    pub context: Context,
    pub found: Vec<ProviderId>,
    pub search_path: Option<String>,
    pub late: bool,
    pub command_line_places: Vec<PathBuf>,
}

An app’s context, and what building it found.

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.

context: Context

found: Vec<ProviderId>

The tools whose program was named outright or found, in ProviderId::ALL’s order. A tool missing here may still be on some PATH, so this narrows what an app offers and never forbids anything.

search_path: Option<String>

The login shell’s PATH, as far as it is looked in: where each tool’s program is looked for, and what a sign-in is given. None where the shell could not be asked, and the app looks on its own PATH, as it always did.

late: bool

The login shell had not answered in time. What was found stands, and asking again a while later may find more.

command_line_places: Vec<PathBuf>

Where each way of installing Pitboard puts pitboard, as command_line_places gives them for this app’s home: under it, and where the system’s package managers put programs. Looked in after the login shell’s PATH for the one a terminal would run.

Implementations

impl AppContext

pub fn discover(env: &Environment, app: Option<&Path>) -> AppContext

The context of an app started with env, which is at app.

Asks the person’s login shell for its PATH, which can take seconds, so this is never called on an app’s main thread.

Trait Implementations

impl Debug for AppContext

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

Formats the value using the given formatter.