Enum ftml::tree::Module

pub enum Module<'t> {
    Backlinks {
        page: Option<Cow<'t, str>>,
    },
    Categories {
        include_hidden: bool,
    },
    Join {
        button_text: Option<Cow<'t, str>>,
        attributes: AttributeMap<'t>,
    },
    PageTree {
        root: Option<Cow<'t, str>>,
        show_root: bool,
        depth: Option<NonZeroU32>,
    },
    Rate,
}

Variants

Backlinks

Fields

page: Option<Cow<'t, str>>

Lists all the backlinks on the given page.

If no page is listed, the backlinks are returned for the current page.

Categories

Fields

include_hidden: bool

Lists all categories on the site, along with the pages they contain.

Join

Fields

button_text: Option<Cow<'t, str>>

attributes: AttributeMap<'t>

Allows a user to join a site.

PageTree

Fields

root: Option<Cow<'t, str>>

show_root: bool

depth: Option<NonZeroU32>

Lists the structure of pages as connected by parenthood.

Shows the hierarchy of parent relationships present on the given page. If no root page is listed, the tree returned is for the current page.

Rate

A rating module, which can be used to vote on the page.

Implementations

impl Module<'_>

pub fn name(&self) -> &'static str

pub fn to_owned(&self) -> Module<'static>

Trait Implementations

impl<'t> Clone for Module<'t>

fn clone(&self) -> Module<'t>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for Module<'t>

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

Formats the value using the given formatter.

impl<'de, 't> Deserialize<'de> for Module<'t>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'t, '_derivative_strum> From<&'_derivative_strum Module<'t>> for &'static str

fn from(x: &'_derivative_strum Module<'t>) -> &'static str

Converts to this type from the input type.

impl<'t> From<Module<'t>> for &'static str

fn from(x: Module<'t>) -> &'static str

Converts to this type from the input type.

impl<'t> PartialEq<Module<'t>> for Module<'t>

fn eq(&self, other: &Module<'t>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'t> Serialize for Module<'t>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'t> Eq for Module<'t>

impl<'t> StructuralEq for Module<'t>

impl<'t> StructuralPartialEq for Module<'t>