Struct unclog::ComponentSection

pub struct ComponentSection {
    pub id: String,
    pub name: String,
    pub maybe_path: Option<String>,
    pub entries: Vec<Entry>,
}

A section of entries related to a specific component/submodule/package.

Fields

id: String

The ID of the component.

name: String

The name of the component.

maybe_path: Option<String>

The path to the component, from the root of the project, if any. Pre-computed and ready to render.

entries: Vec<Entry>

The entries associated with the component.

Implementations

impl ComponentSection

pub fn is_empty(&self) -> bool

Returns whether or not this section is empty (it’s considered empty when it has no entries).

pub fn read_from_dir<P>(config: &Config, path: P) -> Result<Self>

where P: AsRef<Path>,

Attempt to load this component section from the given directory.

pub fn render(&self, config: &Config) -> String

Trait Implementations

impl Clone for ComponentSection

fn clone(&self) -> ComponentSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentSection

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

Formats the value using the given formatter.

impl Hash for ComponentSection

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ComponentSection

fn eq(&self, other: &ComponentSection) -> 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 Eq for ComponentSection

impl StructuralPartialEq for ComponentSection