Struct Bundle 

pub struct Bundle { /* private fields */ }

A loaded OKF bundle.

Implementations

impl Bundle

pub fn load(root: impl AsRef<Path>) -> Result<Bundle, BundleError>

Loads a bundle from a directory tree.

Returns an error only for I/O failures or a non-directory root. Per-file parse failures are recorded in Bundle::parse_errors.

pub fn root(&self) -> &Path

The bundle’s root directory.

pub fn concepts(&self) -> &[Concept]

All successfully parsed concepts, in path order.

pub fn len(&self) -> usize

Number of concepts.

pub fn is_empty(&self) -> bool

true if the bundle has no concepts.

pub fn get(&self, id: &ConceptId) -> Option<&Concept>

Looks up a concept by id.

pub fn contains(&self, id: &ConceptId) -> bool

true if a concept with this id exists.

pub fn index_files(&self) -> &[PathBuf]

Paths of all index.md files found (§6).

pub fn log_files(&self) -> &[PathBuf]

Paths of all log.md files found (§7).

pub fn parse_errors(&self) -> &[(PathBuf, DocumentError)]

Files whose frontmatter could not be parsed during loading.

pub fn links_from(&self, id: &ConceptId) -> &[ResolvedLink]

The resolved outbound cross-links from a concept.

pub fn backlinks(&self, id: &ConceptId) -> &[ConceptId]

The ids of concepts that link to the given concept (“cited by” / § backlinks).

pub fn broken_links(&self) -> Vec<(ConceptId, String)>

All broken internal links in the bundle, as (source, raw_target) pairs. Broken links are permitted by the spec (§5.3) — this is informational.

pub fn okf_version(&self) -> Option<String>

The declared OKF version from the bundle-root index.md frontmatter, if present (okf_version, §11). This is the only place frontmatter is permitted in an index.md.

Trait Implementations

impl Debug for Bundle

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

Formats the value using the given formatter.