Skip to main content

Outline

expectation_docs::outline

Struct Outline 

Source 
pub struct Outline {
    pub parts: Vec<Part>,
    pub pages: Vec<Authored>,
}

Fields§

§parts: Vec<Part>§pages: Vec<Authored>

Implementations§

Source§

impl Outline

Source

pub fn load(suite: &Suite, dir: &Path) -> Option<(Outline, Vec<String>)>

The outline in dir, if it has one. Problems (an unknown section, a missing page) are returned as warnings; the outline then leaves that entry out.

Source

pub fn listed(&self, id: SectionId) -> bool

Whether the outline places this section itself (rather than under its parent).

Source

pub fn anchor(&self, suite: &Suite, id: SectionId) -> Option<(usize, SectionId)>

The part a section is in, and the chapter it is under: the section itself or its nearest ancestor that the outline places.

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, 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, 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.