Struct HookBuilder 

pub struct HookBuilder<H: Hookable> { /* private fields */ }

A struct used in order to specify more options for hooks

You can set three options currently:

• HookBuilder::grouped: Groups this hook with others, allowing them to all be removed at once.
• HookBuilder::filter: Filters when this hook should be called, by giving a struct for which H implements PartialEq. An example is the FocusedOn hook, which accepts Handles and Handle pairs.
• HookBuilder::once: Calls the hook only once.

Implementations

impl<H: Hookable> HookBuilder<H>

pub fn grouped(self, group: impl Into<InnerGroupId>) -> Self

Add a group to this hook

This makes it so you can call hook::remove in order to remove this hook as well as every other hook added to the same group.

There are two types of group, a private GroupId and impl ToString types, which can be removed by an end user.

pub fn once(self) -> Self

Calls this hook only once

This makes it so the hook will only be called once. Note that, if the hook is removed via hook::remove before being called, then it never will be.

pub fn filter<T: Send + 'static>(self, filter: T) -> Self

where H: PartialEq<T>,

Filter when this hook will be called

This is mostly for convenience’s sake, since you could just add a check inside of the callback itself.

This is useful if for example, you want to trigger a hook on only some specific Handle, or some Buffer, things of the sort.

Trait Implementations

impl<H: Hookable> Drop for HookBuilder<H>

fn drop(&mut self)

Executes the destructor for this type.