Skip to main content

Extension

Struct Extension 

Source
pub struct Extension { /* private fields */ }

Implementations§

Source§

impl Extension

Source

pub fn apis(&self) -> Array<BnString>

String indicating the API used by the plugin

Source

pub fn author(&self) -> String

String of the plugin author

Source

pub fn description(&self) -> String

String short description of the plugin

Source

pub fn license_text(&self) -> String

String complete license text for the given plugin

Source

pub fn minimum_version_info(&self) -> VersionInfo

Minimum version info the plugin was tested on

Source

pub fn maximum_version_info(&self) -> VersionInfo

Maximum version info the plugin will support

Source

pub fn versions(&self) -> Array<ExtensionVersion>

Metadata for all available versions of this plugin

Source

pub fn current_version(&self) -> ExtensionVersion

Metadata for the currently selected version of this plugin

Source

pub fn latest_version_id(&self) -> String

Latest version id available for this platform

Source

pub fn name(&self) -> String

String plugin name

Source

pub fn project_url(&self) -> String

String URL of the plugin’s git repository

Source

pub fn package_url(&self) -> String

String URL of the plugin’s git repository

Source

pub fn is_paid(&self) -> bool

Boolean True if this plugin requires payment, False otherwise

Source

pub fn author_url(&self) -> String

String URL of the plugin author’s url

Source

pub fn commit(&self) -> String

String of the commit of this plugin git repository

Source

pub fn path(&self) -> PathBuf

Relative path from the base of the repository to the actual plugin

Source

pub fn subdir(&self) -> PathBuf

Optional sub-directory the plugin code lives in as a relative path from the plugin root

Source

pub fn dependencies(&self) -> String

Dependencies required for installing this plugin

Source

pub fn dependencies_for_version(&self, version_id: &str) -> String

Dependencies required for installing a specific version of this plugin

Source

pub fn dependency_conflicts(&self) -> Vec<PluginDependencyConflict>

Dependency conflicts with installed plugins

Source

pub fn dependency_conflicts_for_version( &self, version_id: &str, ) -> Vec<PluginDependencyConflict>

Dependency conflicts with installed plugins for a specific plugin version

Source

pub fn is_installed(&self) -> bool

true if the plugin is installed, false otherwise

Source

pub fn is_listed(&self) -> bool

true if the plugin is present in its repository’s latest successful listing

Source

pub fn is_deprecated(&self) -> bool

true if the plugin is marked deprecated by its repository

Source

pub fn is_enabled(&self) -> bool

true if the plugin is enabled, false otherwise

Source

pub fn status(&self) -> PluginStatus

Source

pub fn types(&self) -> Array<PluginType>

List of PluginType enumeration objects indicating the plugin type(s)

Source

pub fn enable(&self, force: bool) -> bool

Enable this plugin, optionally trying to force it. Force loading a plugin with ignore platform and api constraints.

Source

pub fn disable(&self) -> bool

Source

pub fn install(&self, version_id: &str) -> bool

Attempt to install the given plugin

Source

pub fn install_dependencies(&self) -> bool

Attempt to install the dependencies of this plugin

Source

pub fn install_dependencies_for_version(&self, version_id: &str) -> bool

Attempt to install the dependencies of a specific version of this plugin

Source

pub fn install_dependencies_for_version_with_exclusions( &self, version_id: &str, excluded_package_names: &[&str], ) -> bool

Attempt to install the dependencies of a specific version of this plugin, excluding some packages by canonical name

Source

pub fn uninstall(&self) -> bool

Attempt to uninstall the given plugin

Source

pub fn cancel_uninstall(&self) -> bool

Cancel an uninstall that is pending until restart.

Source

pub fn updated(&self, version_id: &str) -> bool

Source

pub fn platforms(&self) -> Array<BnString>

List of platforms this plugin can execute on

Source

pub fn repository(&self) -> String

Source

pub fn is_being_deleted(&self) -> bool

Boolean status indicating that the plugin is being deleted

Source

pub fn is_being_updated(&self) -> bool

Boolean status indicating that the plugin is being updated

Source

pub fn is_running(&self) -> bool

Boolean status indicating that the plugin is currently running

Source

pub fn is_update_pending(&self) -> bool

Boolean status indicating that the plugin has updates will be installed after the next restart

Source

pub fn is_disable_pending(&self) -> bool

Boolean status indicating that the plugin will be disabled after the next restart

Source

pub fn is_delete_pending(&self) -> bool

Boolean status indicating that the plugin will be deleted after the next restart

Source

pub fn is_updated_available(&self) -> bool

Boolean status indicating that the plugin has updates available

Source

pub fn are_dependencies_being_installed(&self) -> bool

Boolean status indicating that the plugin’s dependencies are currently being installed

Source

pub fn project_data(&self) -> String

Gets a json object of the project data field

Trait Implementations§

Source§

impl CoreArrayProvider for Extension

Source§

impl Debug for Extension

Source§

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

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

impl ToOwned for Extension

Source§

type Owned = Ref<Extension>

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> Self::Owned

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

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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