Skip to main content

PluginInfo

Struct PluginInfo 

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

Plugin metadata and compatibility information.

PluginInfo contains all the metadata needed to identify, validate, and load a plugin. This includes version information, dependencies, capabilities, and compatibility requirements.

§Example

use trustformers_core::plugins::PluginInfo;

let info = PluginInfo::new(
    "custom_attention",
    "1.2.0",
    "Optimized multi-head attention with flash attention support",
    &["trustformers-core >= 0.1.0", "cuda >= 11.0"]
);

assert_eq!(info.name(), "custom_attention");
assert_eq!(info.version().to_string(), "1.2.0");
assert!(info.is_compatible_with("trustformers-core", "0.2.0"));

Implementations§

Source§

impl PluginInfo

Source

pub fn new( name: &str, version: &str, description: &str, dependencies: &[&str], ) -> Self

Creates a new plugin info instance.

§Arguments
  • name - Plugin name
  • version - Plugin version string (must be valid semver)
  • description - Plugin description
  • dependencies - Array of dependency specifications
§Returns

A new PluginInfo instance.

§Panics

Panics if the version string is not valid semver.

§Example
use trustformers_core::plugins::PluginInfo;

let info = PluginInfo::new(
    "my_plugin",
    "1.0.0",
    "A sample plugin",
    &["trustformers-core >= 0.1.0"]
);
Source

pub fn name(&self) -> &str

Returns the plugin name.

Source

pub fn version(&self) -> &Version

Returns the plugin version.

Source

pub fn description(&self) -> &str

Returns the plugin description.

Source

pub fn author(&self) -> Option<&str>

Returns the plugin author.

Source

pub fn set_author(&mut self, author: String)

Sets the plugin author.

Source

pub fn homepage(&self) -> Option<&str>

Returns the plugin homepage URL.

Source

pub fn set_homepage(&mut self, homepage: String)

Sets the plugin homepage URL.

Source

pub fn license(&self) -> Option<&str>

Returns the plugin license.

Source

pub fn set_license(&mut self, license: String)

Sets the plugin license.

Source

pub fn dependencies(&self) -> &[Dependency]

Returns the plugin dependencies.

Source

pub fn add_dependency(&mut self, dependency: Dependency)

Adds a dependency requirement.

Source

pub fn capabilities(&self) -> &[String]

Returns the plugin capabilities.

Source

pub fn add_capability(&mut self, capability: String)

Adds a capability.

Source

pub fn tags(&self) -> &[String]

Returns the plugin tags.

Source

pub fn add_tag(&mut self, tag: String)

Adds a tag.

Source

pub fn requirements(&self) -> &SystemRequirements

Returns the system requirements.

Source

pub fn set_requirements(&mut self, requirements: SystemRequirements)

Sets the system requirements.

Source

pub fn entry_point(&self) -> &str

Returns the plugin entry point.

Source

pub fn set_entry_point(&mut self, entry_point: String)

Sets the plugin entry point.

Source

pub fn metadata(&self) -> &HashMap<String, Value>

Returns the plugin metadata.

Source

pub fn add_metadata(&mut self, key: String, value: Value)

Adds metadata.

Source

pub fn is_compatible_with(&self, name: &str, version: &str) -> bool

Checks if this plugin is compatible with a given dependency.

§Arguments
  • name - The dependency name
  • version - The dependency version
§Returns

true if compatible, false otherwise.

Source

pub fn validate(&self) -> Result<()>

Validates the plugin info for completeness and correctness.

§Returns

Ok(()) if valid, error otherwise.

Trait Implementations§

Source§

impl Clone for PluginInfo

Source§

fn clone(&self) -> PluginInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PluginInfo

Source§

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

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

impl<'de> Deserialize<'de> for PluginInfo

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PluginInfo

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> ConfigSerializable for T
where T: Serialize + for<'de> Deserialize<'de>,

Source§

fn to_json(&self) -> Result<String, TrustformersError>

Serialize to JSON string
Source§

fn from_json(json: &str) -> Result<T, TrustformersError>

Deserialize from JSON string
Source§

fn save_to_file(&self, path: &Path) -> Result<()>

Save to file
Source§

fn load_from_file(path: &Path) -> Result<Self>
where Self: Sized,

Load from file
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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,