Struct PluginMetadata 

pub struct PluginMetadata {
    pub name: String,
    pub version: String,
    pub author: String,
    pub description: String,
    pub supported_categories: Vec<HardwareCategory>,
    pub min_platform_version: Option<String>,
    pub config_schema: Option<String>,
    pub dependencies: Vec<String>,
    pub enabled_by_default: bool,
}

Plugin metadata for identification and configuration

Fields

name: String

Plugin name

version: String

Plugin version

author: String

Plugin author

description: String

Plugin description

supported_categories: Vec<HardwareCategory>

Supported hardware categories

min_platform_version: Option<String>

Minimum platform version requirement

config_schema: Option<String>

Plugin configuration schema (JSON)

dependencies: Vec<String>

Dependencies

enabled_by_default: bool

Whether the plugin is enabled by default

Implementations

impl PluginMetadata

pub fn new( name: String, version: String, author: String, description: String, ) -> Self

Creates new plugin metadata

pub fn with_category(self, category: HardwareCategory) -> Self

Adds a supported hardware category

pub fn with_min_platform_version(self, version: String) -> Self

Sets the minimum platform version

pub fn with_config_schema(self, schema: &str) -> Self

Sets the configuration schema

pub fn with_dependency(self, dep: String) -> Self

Adds a dependency

pub fn with_enabled_by_default(self, enabled: bool) -> Self

Sets whether the plugin is enabled by default

Trait Implementations

impl Clone for PluginMetadata

fn clone(&self) -> PluginMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for PluginMetadata

type Target = PluginMetadata

The Python output type

type Output = Bound<'py, <PluginMetadata as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PluginMetadata

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PluginMetadata

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Plugin metadata for identification and configuration

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PluginMetadata>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyTypeInfo for PluginMetadata

const NAME: &'static str = "PluginMetadata"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for PluginMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for PluginMetadata

impl ExtractPyClassWithClone for PluginMetadata