SiteTree

Struct SiteTree 

Source
pub struct SiteTree { /* private fields */ }
Expand description

Code representation of all nodes within the site (hiarchy and how nodes are related)

Implementations§

Source§

impl SiteTree

Source

pub fn from_input(input: Input) -> Result<SiteTree, LssgError>

input is a markdown input file from where to start discovering resources and pages

Source

pub fn is_parent(&self, id: SiteId, parent_id: SiteId) -> bool

Check if node id has parent_id as (grand)parent node

Source

pub fn get_input(&self, id: SiteId) -> Option<&Input>

try and get the input of a node if input exists

Source

pub fn get_by_name(&self, name: &str, id: SiteId) -> Option<&SiteId>

Source

pub fn root(&self) -> SiteId

Source

pub fn get(&self, id: SiteId) -> Result<&SiteNode, LssgError>

Source

pub fn page_parent(&self, id: SiteId) -> Option<SiteId>

get next parent of page

Source

pub fn parents(&self, id: SiteId) -> Vec<SiteId>

Get all parents from a node

Source

pub fn path(&self, id: SiteId) -> String

Get the absolute path of a node

Source

pub fn rel_path(&self, from: SiteId, to: SiteId) -> String

Get the relative path between two nodes

Source

pub fn ids(&self) -> Vec<SiteId>

Get all the relations from a single node to other nodes

Source

pub fn add(&mut self, node: SiteNode) -> Result<SiteId, LssgError>

Utility function to add a node, create a id and add to parent children

Source

pub fn add_from_input( &mut self, input: Input, parent_id: SiteId, ) -> Result<SiteId, LssgError>

add from Input, will figure out what node to add from input and will register input not to be used for other nodes

Source

pub fn add_stylesheet_from_input( &mut self, input: Input, parent: SiteId, ) -> Result<SiteId, LssgError>

Add a stylesheet and all resources needed by the stylesheet

Source

pub fn remove(&mut self, id: SiteId)

Source

pub fn minify(&mut self)

Concat resources and minify what can be minified

Trait Implementations§

Source§

impl Debug for SiteTree

Source§

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

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

impl Display for SiteTree

Source§

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

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

impl Index<usize> for SiteTree

Source§

type Output = SiteNode

The returned type after indexing.
Source§

fn index(&self, index: SiteId) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<usize> for SiteTree

Source§

fn index_mut(&mut self, index: SiteId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,