Skip to main content

TeardownRegistries

Struct TeardownRegistries 

Source
pub struct TeardownRegistries<'a> {
Show 15 fields pub commands: &'a mut CommandRegistry, pub pickers: &'a mut PickerRegistry, pub provider_views: Option<&'a ProviderViewRegistry>, pub modes: &'a mut ModeRegistry, pub keymap: &'a KeymapHandle, pub config: &'a ConfigRegistry, pub bus: &'a EventBus, pub decorations: &'a mut GutterDecorationSourceRegistry, pub media: &'a mut MediaSourceRegistry, pub agenda: &'a mut ScannedExcerptSourceRegistry, pub contexts: &'a mut ContextSourceRegistry, pub theme: &'a dyn ThemeRegistry, pub signs: Option<&'a SignRegistryHandle>, pub modeline: Option<&'a ModelineServiceHandle>, pub parsers: &'a CompilationParserFactoriesHandle,
}
Expand description

The host-owned registries a plugin’s contributions live in — the set PluginTeardown::unload reverses against. Grouped as a borrow struct so unload takes one argument instead of six, and so the caller passes exactly the registries a &mut Editor context already holds. All are required: a plugin can contribute to any surface, and passing the whole set is cheaper than threading option-ness through the driver (an unexercised surface’s reversal is already a no-op).

Fields§

§commands: &'a mut CommandRegistry§pickers: &'a mut PickerRegistry§provider_views: Option<&'a ProviderViewRegistry>

MV.1: where a plugin’s declared multibuffer views registered their openers. Option because a headless boot may not publish the seam, and a teardown must not require a service the load never used.

§modes: &'a mut ModeRegistry§keymap: &'a KeymapHandle§config: &'a ConfigRegistry§bus: &'a EventBus§decorations: &'a mut GutterDecorationSourceRegistry

PL8.E: the decoration-producer registry (unregister by producer id).

§media: &'a mut MediaSourceRegistry

IM.6b: the media-producer registry, for the same reversal.

§agenda: &'a mut ScannedExcerptSourceRegistry

OM.A1: the agenda-producer registry, for the same reversal.

§contexts: &'a mut ContextSourceRegistry

TC.2: the context-producer registry (unregister by producer id).

§theme: &'a dyn ThemeRegistry

TC.4: the theme registry (unregister_element by namespaced name).

§signs: Option<&'a SignRegistryHandle>

SG.3a: the sign registry (undefine by namespaced name).

Option, like modeline and for the same reason: the loader gates the whole reversal on one all-or-nothing tuple of handles, so making this required would turn every unload in a harness that has not wired a sign registry into a silent no-op — options, commands and all. A sign registry is not a precondition for reversing a config option.

§modeline: Option<&'a ModelineServiceHandle>

OC.3 / ML.6: the modeline element registry (clear + remove by namespaced id). A handle, not a &mut — ModelineService is ArcSwap-backed interior-mutable, like theme above.

Option, unlike its neighbours, and the reason is a bug this field caused before it was one: the loader gates the whole reversal on a single all-or-nothing tuple of registry handles, so making the modeline a required member turned every unload in a harness that had not wired one into a silent no-op — options, commands and all. A modeline is not a precondition for reversing a config option. Wired-ness is still checked where it belongs, in WiredSeams::all(), which the boot pin asserts.

§parsers: &'a CompilationParserFactoriesHandle

CM.6b: the compilation parser-factory registry (unregister_plugin by host-issued id, RCU’d like the other ArcSwap-held registries).

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
§

impl<T> Pointee for T

§

type Pointer = u32

§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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