Skip to main content

PluginHost

Struct PluginHost 

Source
pub struct PluginHost { /* private fields */ }
Expand description

All discovered plugins.

Implementations§

Source§

impl PluginHost

Source

pub fn discover() -> Self

Discover plugins in Self::roots.

Source

pub fn roots() -> Vec<PathBuf>

Where plugins are discovered, in shadowing order: the user’s data directory, then the system data directories ($XDG_DATA_DIRS, so distro packages under /usr/share/jump/plugins are picked up with no configuration).

The user’s directory is searched first and wins on an id collision, so copying a packaged plugin into ~/.local/share/jump/plugins to modify it shadows the packaged one rather than duplicating it.

Source

pub fn discover_in(roots: &[PathBuf]) -> Self

Discover plugins under roots, earlier roots shadowing later ones.

Directories without a readable manifest are skipped with a warning; a malformed plugin must never prevent the launcher from starting.

Source

pub fn replace_plugins(&mut self, discovered: Self) -> bool

Take the plugins from a fresh discovery, keeping the user’s disabled set and keyword overrides, which belong to settings rather than to what is on disk. Returns whether the plugin set actually changed.

Source

pub fn set_disabled<I, S>(&mut self, ids: I)
where I: IntoIterator<Item = S>, S: Into<String>,

Replace the set of switched-off plugins, e.g. when settings change.

Source

pub fn set_keyword_overrides<I, K, V>(&mut self, overrides: I)
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Replace the keyword overrides, e.g. when settings change.

Source

pub fn effective_keyword<'a>(&'a self, plugin: &'a Plugin) -> Option<&'a str>

The keyword plugin currently answers to: the user’s override when one exists (empty meaning “no keyword”), else the manifest’s.

Source

pub fn all(&self) -> impl Iterator<Item = (&Plugin, bool)>

Every discovered plugin, the switched-off ones included, with whether each is currently enabled. This is the settings window’s list.

Source

pub fn is_empty(&self) -> bool

Whether no plugins were discovered.

Source

pub fn get(&self, id: &str) -> Option<&Plugin>

Look up an enabled plugin. Activation goes through here, so a plugin disabled between query and click does nothing rather than running.

Source

pub async fn query(&self, text: &str) -> QueryResults

Query every plugin that matches, concurrently.

Plugins run in parallel and share the same deadline, so total latency is the slowest matching plugin rather than the sum.

Source

pub fn is_claimed(&self, text: &str) -> bool

Whether a keyworded plugin claims this query, meaning pop-launcher results should be suppressed.

Trait Implementations§

Source§

impl Clone for PluginHost

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PluginHost

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PluginHost

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more