Skip to main content

AddonRegistry

Struct AddonRegistry 

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

插件注册中心

对齐 PHP think\addons\Service 中隐式的插件状态管理。

§线程安全

使用 RwLock<HashMap<String, AddonManifest>> 实现,支持多读单写。

§用法

use sz_rust_addons_loader::registry::AddonRegistry;
use sz_rust_addons_loader::manifest::AddonManifest;

let registry = AddonRegistry::new();
let manifest = AddonManifest::new("operate");
registry.register(manifest).unwrap();

assert!(registry.exists("operate"));
assert_eq!(registry.count(), 1);

Implementations§

Source§

impl AddonRegistry

Source

pub fn new() -> Self

创建空注册中心

Source

pub fn register(&self, manifest: AddonManifest) -> AddonLoaderResult<()>

注册插件(对齐 PHP get_addons_instance 缓存到 $_addons[$name]

§错误
  • AddonNotFound:插件名已存在(不覆盖)
Source

pub fn upsert(&self, manifest: AddonManifest)

强制注册或更新插件(对齐 PHP array_merge 覆盖行为)

Source

pub fn unregister(&self, name: &str) -> AddonLoaderResult<Option<AddonManifest>>

注销插件(对齐 PHP unset($_addons[$name])

§返回
  • Ok(Some(manifest)):插件已存在并已移除
  • Ok(None):插件不存在
Source

pub fn get(&self, name: &str) -> AddonLoaderResult<AddonManifest>

查询插件清单(对齐 PHP get_addons_info($name)

§错误
  • AddonNotFound:插件不存在
Source

pub fn try_get(&self, name: &str) -> Option<AddonManifest>

尝试查询插件清单(不返回错误)

Source

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

判断插件是否存在(对齐 PHP class_exists 检查)

Source

pub fn is_enabled(&self, name: &str) -> AddonLoaderResult<bool>

判断插件是否启用(对齐 PHP Route::execute!$info['status'] 检查)

§返回
  • Ok(true):插件存在且 status != 0
  • Ok(false):插件存在但 status == 0
  • Err(AddonNotFound):插件不存在
Source

pub fn set_enabled(&self, name: &str, enabled: bool) -> AddonLoaderResult<()>

设置插件状态(对齐 PHP 修改 $info['status']

§参数
  • name:插件名
  • enabled:true=1(启用),false=0(禁用)
Source

pub fn names(&self) -> Vec<String>

获取所有已注册的插件名(按字母序,对齐 PHP scandir 排序)

Source

pub fn all(&self) -> Vec<AddonManifest>

获取所有已注册的插件清单(按名字序)

Source

pub fn enabled_addons(&self) -> Vec<AddonManifest>

获取所有启用的插件清单(按名字序)

Source

pub fn disabled_addons(&self) -> Vec<AddonManifest>

获取所有禁用的插件清单(按名字序)

Source

pub fn count(&self) -> usize

获取已注册插件数量

Source

pub fn clear(&self)

清空注册中心

Source

pub fn load_from_directory( &self, addons_path: &Path, ) -> AddonLoaderResult<Vec<AddonLoaderError>>

从插件目录批量加载并注册(对齐 PHP Service::loadService 扫描逻辑)

§扫描规则

对齐 PHP scandir($addons_path)

  1. 扫描 addons_path 下的所有子目录
  2. 跳过 . .. 及文件项
  3. 子目录必须包含 Plugin.php(对齐 PHP is_file($addonDir . ucfirst($name) . '.php'),Rust 侧统一使用 Plugin.php
  4. 解析 Plugin.php 中的 $info 数组
  5. 注册到注册中心
§错误处理
  • 单个插件解析失败不会中断整体扫描,但会记录到返回的错误列表
  • 目录读取失败返回 ScanDir 错误
Source

pub fn addon_path(&self, name: &str) -> AddonLoaderResult<PathBuf>

获取插件文件路径(对齐 PHP getAddonsPath() . $name . DIRECTORY_SEPARATOR

Trait Implementations§

Source§

impl Debug for AddonRegistry

Source§

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

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

impl Default for AddonRegistry

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> 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, 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<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