ModeSet

Struct ModeSet 

Source
pub struct ModeSet<M: Mode>(/* private fields */);
Expand description

Hookable: Lets you modify a Mode as it is set

§Arguments

  • The new mode.
  • Its widget.

This hook is very useful if you want to, for example, set different options upon switching to modes, depending on things like the language of a Buffer.

§Aliases

Since every Mode implements the HookAlias trait, given a duat_kak plugin imported as kak, instead of writing this:

setup_duat!(setup);
use duat::prelude::*;
use duat_kak::Normal;

fn setup() {
    hook::add::<ModeSet<Normal>>(|pa, (normal, handle)|
        Ok(normal.indent_on_capital_i = true)
    );
}

You can just write this:

setup_duat!(setup);
use duat::prelude::*;
use duat_kak::Normal;

fn setup() {
    hook::add::<Normal>(|pa, (normal, handle)|
        Ok(normal.indent_on_capital_i = true)
    );
}

§Note

You should try to avoid more than one Mode with the same name. This can happen if you’re using two structs with the same name, but from different crates.

Trait Implementations§

Source§

impl<M: Mode> Hookable for ModeSet<M>

Source§

type Input<'h> = (&'h mut M, &'h Handle<<M as Mode>::Widget>)

The arguments that are passed to each hook.
Source§

fn get_input(&mut self) -> Self::Input<'_>

How to get the arguments from the Hookable

Auto Trait Implementations§

§

impl<M> !Freeze for ModeSet<M>

§

impl<M> !RefUnwindSafe for ModeSet<M>

§

impl<M> Send for ModeSet<M>

§

impl<M> Sync for ModeSet<M>
where M: Sync,

§

impl<M> Unpin for ModeSet<M>
where M: Unpin,

§

impl<M> !UnwindSafe for ModeSet<M>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<H> HookAlias for H
where H: Hookable,

Source§

type Hookable = H

The actual Hookable that this HookAlias is supposed to map to
Source§

type Input<'h> = <H as Hookable>::Input<'h>

Just a shorthand for less boilerplate in the function definition
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.