Struct markdown_composer::types::header::Header

pub struct Header {
    pub text: String,
    pub level: HeaderLevel,
}

A markdown header.

Fields

text: String

The header text.

level: HeaderLevel

The header level.

Implementations

impl Header

pub fn new() -> Self

Creates a new empty header with a level of 1.

pub fn from(text: impl Into<String>, level: impl Into<HeaderLevel>) -> Self

Creates a new header.

Panics

Panics if the header level is not valid (one to six inclusive).

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the "default value" for a type.

impl Display for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq<Header> for Header

fn eq(&self, other: &Header) -> bool

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

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

This method tests for !=.

impl StructuralEq for Header

impl StructuralPartialEq for Header