Struct PageList 

#[non_exhaustive]
pub struct PageList {
    pub pages: Vec<String>,
    pub notes: Vec<Note>,
}

A parsed page list: {"src": ["pages/Index", …]}.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pages: Vec<String>

Page paths relative to the module’s ets/ directory, without extension, in file order.

notes: Vec<Note>

Fields that were present but wrongly typed, and so skipped.

Implementations

impl PageList

pub fn parse(bytes: &[u8]) -> Result<Self, HapError>

Read a page list.

Errors

Only when bytes is not JSON or its root is not an object.

pub fn src_entry(page: &str) -> String

The srcEntry spelling of page, which ModuleJson::record_names takes: ./ets/pages/Index for pages/Index.

pub fn line(page: &str) -> String

The summary line of page: page pages/Index.

Trait Implementations

impl Clone for PageList

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageList

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

Formats the value using the given formatter.

impl Default for PageList

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PageList

impl PartialEq for PageList

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageList