🚧 Retoques menores en la documentación
This commit is contained in:
parent
10a8a1136c
commit
efd4975a50
4 changed files with 12 additions and 8 deletions
|
|
@ -49,7 +49,7 @@ pub enum ContextError {
|
||||||
///
|
///
|
||||||
/// `Contextual` extiende [`LangId`] para establecer el idioma del documento y añade métodos para:
|
/// `Contextual` extiende [`LangId`] para establecer el idioma del documento y añade métodos para:
|
||||||
///
|
///
|
||||||
/// - Almacenar la **solicitud HTTP** de origen.
|
/// - Almacenar la **petición HTTP** de origen.
|
||||||
/// - Seleccionar el **tema** y la **plantilla** de renderizado.
|
/// - Seleccionar el **tema** y la **plantilla** de renderizado.
|
||||||
/// - Administrar **recursos** del documento como el icono [`Favicon`], las hojas de estilo
|
/// - Administrar **recursos** del documento como el icono [`Favicon`], las hojas de estilo
|
||||||
/// [`StyleSheet`] o los scripts [`JavaScript`] mediante [`ContextOp`].
|
/// [`StyleSheet`] o los scripts [`JavaScript`] mediante [`ContextOp`].
|
||||||
|
|
@ -81,7 +81,7 @@ pub trait Contextual: LangId {
|
||||||
#[builder_fn]
|
#[builder_fn]
|
||||||
fn with_langid(self, language: &impl LangId) -> Self;
|
fn with_langid(self, language: &impl LangId) -> Self;
|
||||||
|
|
||||||
/// Almacena la solicitud HTTP de origen en el contexto.
|
/// Almacena la petición HTTP de origen en el contexto.
|
||||||
#[builder_fn]
|
#[builder_fn]
|
||||||
fn with_request(self, request: Option<HttpRequest>) -> Self;
|
fn with_request(self, request: Option<HttpRequest>) -> Self;
|
||||||
|
|
||||||
|
|
@ -107,7 +107,7 @@ pub trait Contextual: LangId {
|
||||||
|
|
||||||
// **< Contextual GETTERS >*********************************************************************
|
// **< Contextual GETTERS >*********************************************************************
|
||||||
|
|
||||||
/// Devuelve una referencia a la solicitud HTTP asociada, si existe.
|
/// Devuelve una referencia a la petición HTTP asociada, si existe.
|
||||||
fn request(&self) -> Option<&HttpRequest>;
|
fn request(&self) -> Option<&HttpRequest>;
|
||||||
|
|
||||||
/// Devuelve el tema que se usará para renderizar el documento.
|
/// Devuelve el tema que se usará para renderizar el documento.
|
||||||
|
|
@ -161,7 +161,7 @@ pub trait Contextual: LangId {
|
||||||
///
|
///
|
||||||
/// # Ejemplos
|
/// # Ejemplos
|
||||||
///
|
///
|
||||||
/// Crea un nuevo contexto asociado a una solicitud HTTP:
|
/// Crea un nuevo contexto asociado a una petición HTTP:
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # use pagetop::prelude::*;
|
/// # use pagetop::prelude::*;
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ use crate::{builder_fn, AutoDefault};
|
||||||
/// Some("¡Hola mundo!".to_string())
|
/// Some("¡Hola mundo!".to_string())
|
||||||
/// );
|
/// );
|
||||||
///
|
///
|
||||||
/// // Japonés no disponible, traduce al idioma de respaldo ("en-US").
|
/// // Japonés no disponible, traduce al idioma de respaldo (`"en-US"`).
|
||||||
/// assert_eq!(
|
/// assert_eq!(
|
||||||
/// hello.lookup(&LangMatch::resolve("ja-JP")),
|
/// hello.lookup(&LangMatch::resolve("ja-JP")),
|
||||||
/// Some("Hello world!".to_string())
|
/// Some("Hello world!".to_string())
|
||||||
|
|
|
||||||
|
|
@ -101,7 +101,7 @@ pub struct Page {
|
||||||
impl Page {
|
impl Page {
|
||||||
/// Crea una nueva instancia de página.
|
/// Crea una nueva instancia de página.
|
||||||
///
|
///
|
||||||
/// La solicitud HTTP se guardará en el contexto de renderizado de la página para poder ser
|
/// La petición HTTP se guardará en el contexto de renderizado de la página para poder ser
|
||||||
/// recuperada por los componentes si es necesario.
|
/// recuperada por los componentes si es necesario.
|
||||||
#[rustfmt::skip]
|
#[rustfmt::skip]
|
||||||
pub fn new(request: HttpRequest) -> Self {
|
pub fn new(request: HttpRequest) -> Self {
|
||||||
|
|
@ -211,7 +211,7 @@ impl Page {
|
||||||
/// Devuelve una referencia mutable al [`Context`] de la página.
|
/// Devuelve una referencia mutable al [`Context`] de la página.
|
||||||
///
|
///
|
||||||
/// El [`Context`] actúa como intermediario para muchos métodos de `Page` (idioma, tema,
|
/// El [`Context`] actúa como intermediario para muchos métodos de `Page` (idioma, tema,
|
||||||
/// *layout*, recursos, solicitud HTTP, etc.). Resulta especialmente útil cuando un componente
|
/// *layout*, recursos, petición HTTP, etc.). Resulta especialmente útil cuando un componente
|
||||||
/// o un tema necesita recibir el contexto como parámetro.
|
/// o un tema necesita recibir el contexto como parámetro.
|
||||||
pub fn context(&mut self) -> &mut Context {
|
pub fn context(&mut self) -> &mut Context {
|
||||||
&mut self.context
|
&mut self.context
|
||||||
|
|
@ -289,6 +289,10 @@ impl Page {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Permite a [`Page`] actuar como proveedor de idioma usando el [`Context`] de la página.
|
||||||
|
///
|
||||||
|
/// Resulta útil para usar [`Page`] directamente como fuente de traducción en [`L10n::lookup()`] o
|
||||||
|
/// [`L10n::using()`].
|
||||||
impl LangId for Page {
|
impl LangId for Page {
|
||||||
fn langid(&self) -> &'static LanguageIdentifier {
|
fn langid(&self) -> &'static LanguageIdentifier {
|
||||||
self.context.langid()
|
self.context.langid()
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,6 @@ pub use indoc::{concatdoc, formatdoc, indoc};
|
||||||
|
|
||||||
// **< MACROS ÚTILES >******************************************************************************
|
// **< MACROS ÚTILES >******************************************************************************
|
||||||
|
|
||||||
#[macro_export]
|
|
||||||
/// Macro para construir una colección de pares clave-valor.
|
/// Macro para construir una colección de pares clave-valor.
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
|
|
@ -31,6 +30,7 @@ pub use indoc::{concatdoc, formatdoc, indoc};
|
||||||
/// "userGender" => "male",
|
/// "userGender" => "male",
|
||||||
/// ];
|
/// ];
|
||||||
/// ```
|
/// ```
|
||||||
|
#[macro_export]
|
||||||
macro_rules! hm {
|
macro_rules! hm {
|
||||||
( $($key:expr => $value:expr),* $(,)? ) => {{
|
( $($key:expr => $value:expr),* $(,)? ) => {{
|
||||||
let mut a = std::collections::HashMap::new();
|
let mut a = std::collections::HashMap::new();
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue