Struct LayoutComponent

pub struct LayoutComponent {
    pub json: String,
    pub component: ComponentName,
    pub options: HashMap<String, String>,
    pub children: Vec<LayoutComponent>,
}

A component of the layout. Essentially just a limited description of an HTML element.

Fields

json: String

component: ComponentName

options: HashMap<String, String>

children: Vec<LayoutComponent>

Implementations

impl LayoutComponent

pub fn from_json_file(file: &str) -> Self

Create a LayoutComponent from the name of a file in ./.config/layouts.

pub fn fill(&self) -> LayoutComponent

Follow component template to get full template.

All imports are relative to ./.config/layouts.

pub fn option(&self, k: &str, d: Option<String>) -> String

Get the value of an option in the options map. Accepts a default substitute.

pub fn render(&self, user: &Profile) -> String

Render the component as HTML. Skips rendering with extra junk.

See FreeRendererTemplate. See LayoutComponent::render_with_junk to include junk.

pub fn render_with_junk( &self, user: &Profile, config: &Config, profile: &Option<Box<Profile>>, lang: &LangFile, response_count: usize, questions_count: usize, followers_count: usize, following_count: usize, friends_count: usize, is_following: bool, is_following_you: bool, relationship: RelationshipStatus, lock_profile: bool, disallow_anonymous: bool, require_account: bool, hide_social: bool, is_powerful: bool, is_helper: bool, is_self: bool, ) -> String

Render the component as HTML. Since this is a profile layout, we require a reference to the Profile this layout is being rendered for.

pub fn render_block(&self) -> String

Render the component to block format. This format doesn’t show the fully rendered form of the layout, but instead just blocks which represent the component.

This rendering is used in the editor because it saves so many server resources. The normal rendering eats memory, as it recursively renders the same HTML template.

The only component rendered halfway normally as a block is ComponentName::Flex components.

pub fn render_tree(&self) -> String

Render the component to tree format (using HTML <details>).

Trait Implementations

impl AsRef<LayoutComponent> for LayoutComponent

fn as_ref(&self) -> &LayoutComponent

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LayoutComponent

fn clone(&self) -> LayoutComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutComponent

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

Formats the value using the given formatter.

impl Default for LayoutComponent

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LayoutComponent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LayoutComponent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.