Skip to main content

HookEvent

Enum HookEvent 

Source
pub enum HookEvent {
Show 16 variants BeforeInsert, AfterInsert, BeforeUpdate, AfterUpdate, BeforeDelete, AfterDelete, BeforeWrite, AfterWrite, BeforeSave, AfterSave, BeforeRestore, AfterRestore, BeforeFind, AfterFind, BeforeValidate, AfterValidate,
}
Expand description

钩子事件类型

在 think-orm 风格的 6 个细粒度 insert/update/delete 事件基础上, 进一步提供 6 个通用写入事件(write/save/restore):

  • BeforeWrite / AfterWrite:任何写入操作(insert/update)前后触发
  • BeforeSave / AfterSave:插入或更新保存前后触发(与 write 等价,命名借用 Rails/ActiveRecord)
  • BeforeRestore / AfterRestore:软删除恢复前后触发

此外还提供 4 个查询/验证事件:

  • BeforeFind / AfterFind:单行 SELECT 前后触发(可用于查询缓存、审计)
  • BeforeValidate / AfterValidate:数据验证前后触发(写入前的业务规则校验)

触发顺序示例(执行 INSERT 时): BeforeWriteBeforeSaveBeforeValidateBeforeInsert → (INSERT) → AfterInsertAfterSaveAfterWrite

触发顺序示例(执行 SELECT 时): BeforeFind → (SELECT) → AfterFind

Variants§

§

BeforeInsert

§

AfterInsert

§

BeforeUpdate

§

AfterUpdate

§

BeforeDelete

§

AfterDelete

§

BeforeWrite

通用写入前:insert 或 update 前均触发

§

AfterWrite

通用写入后:insert 或 update 后均触发

§

BeforeSave

保存前(与 BeforeWrite 等价,命名风格不同)

§

AfterSave

保存后(与 AfterWrite 等价,命名风格不同)

§

BeforeRestore

软删除恢复前

§

AfterRestore

软删除恢复后

§

BeforeFind

查询前(单行 SELECT 前触发,可用于查询缓存预热、审计日志)

§

AfterFind

查询后(单行 SELECT 后触发,可用于查询结果后处理、缓存填充)

§

BeforeValidate

数据验证前(写入前的业务规则校验,在 before_insert/before_update 之前触发)

§

AfterValidate

数据验证后(验证完成后触发,可清理临时状态)

Implementations§

Source§

impl HookEvent

Source

pub fn is_before(&self) -> bool

是否为 before 事件

Source

pub fn is_after(&self) -> bool

是否为 after 事件

Source

pub fn is_write_level(&self) -> bool

是否为通用写入事件(write/save)

Source

pub fn is_find_level(&self) -> bool

是否为查询事件(find)

Source

pub fn is_validate_level(&self) -> bool

是否为验证事件(validate)

Source

pub fn is_fine_grained(&self) -> bool

是否为细粒度事件(v0.2.0+ 新增的事件)

Trait Implementations§

Source§

impl Clone for HookEvent

Source§

fn clone(&self) -> HookEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for HookEvent

Source§

impl Debug for HookEvent

Source§

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

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

impl Eq for HookEvent

Source§

impl Hash for HookEvent

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for HookEvent

Source§

fn eq(&self, other: &HookEvent) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HookEvent

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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