pagetop 0.5.0

Un entorno de desarrollo para crear soluciones web modulares, extensibles y configurables.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use crate::core::AnyInfo;
use crate::{UniqueId, Weight};

/// Tipo dinámico para encapsular cualquier acción que implementa [`ActionDispatcher`].
pub type ActionBox = Box<dyn ActionDispatcher>;

/// Clave para registrar las acciones y seleccionar las funciones asociadas.
///
/// Las funciones seleccionadas se van a [despachar](crate::core::action::dispatch_actions) y
/// ejecutar en un punto concreto del flujo de ejecución.
#[derive(Eq, PartialEq, Hash)]
pub struct ActionKey {
    action_type_id: UniqueId,
    referer_type_id: Option<UniqueId>,
    referer_id: Option<String>,
}

impl ActionKey {
    /// Crea una nueva clave para un tipo de acción.
    ///
    /// Se crea con los siguientes campos:
    ///
    /// - `action_type_id`: Tipo de la acción.
    /// - `referer_type_id`: Opcional, identificador de tipo ([`UniqueId`]) del componente referido.
    /// - `referer_id`: Opcional, identificador de la instancia (p. ej. para asociar la acción a un
    ///   componente concreto).
    ///
    /// Esta clave permitirá seleccionar las funciones a ejecutar para ese tipo de acción, con
    /// filtros opcionales por componente o por una instancia concreta según su identificador.
    pub fn new(
        action_type_id: UniqueId,
        referer_type_id: Option<UniqueId>,
        referer_id: Option<String>,
    ) -> Self {
        ActionKey {
            action_type_id,
            referer_type_id,
            referer_id,
        }
    }
}

/// Implementa el filtro predeterminado para despachar las funciones de una acción dada.
///
/// Las acciones tienen que sobrescribir los métodos para el filtro que apliquen. Por defecto
/// implementa un filtro nulo.
pub trait ActionDispatcher: AnyInfo + Send + Sync {
    /// Identificador de tipo ([`UniqueId`]) del objeto referido. En este caso devuelve `None`.
    fn referer_type_id(&self) -> Option<UniqueId> {
        None
    }

    /// Identificador del objeto referido. En este caso devuelve `None`.
    fn referer_id(&self) -> Option<String> {
        None
    }

    /// Funciones con pesos más bajos se aplican antes. En este caso siempre devuelve `0`.
    fn weight(&self) -> Weight {
        0
    }
}