Struct SourceBundle 

pub struct SourceBundle { /* private fields */ }

Bounded, immutable-at-parse-time collection of uncompressed roff sources.

Paths use / separators and are exact relative logical identities. Empty components, ., .., absolute paths, backslashes, and NUL bytes are rejected. The native parser can only resolve .so requests to entries in this collection; it never falls back to the host filesystem.

Implementations

impl SourceBundle

pub const fn new() -> Self

Create an empty source bundle.

pub fn len(&self) -> usize

Return the number of logical sources in this bundle.

pub fn is_empty(&self) -> bool

Return whether this bundle contains no sources.

pub const fn total_bytes(&self) -> usize

Return the aggregate uncompressed byte size.

pub fn get(&self, path: &str) -> Option<&[u8]>

Return one exact logical source.

pub fn insert( &mut self, path: impl Into<String>, source: impl Into<Vec<u8>>, ) -> Result<Option<Vec<u8>>, SourceBundleError>

Insert or replace one uncompressed source.

The previous bytes are returned when path already existed. Failed insertions leave the bundle unchanged.

Errors

Returns SourceBundleError when the logical path is unsafe or a documented source-count or byte limit would be exceeded.

Trait Implementations

impl Clone for SourceBundle

fn clone(&self) -> SourceBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceBundle

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

Formats the value using the given formatter.

impl Default for SourceBundle

fn default() -> SourceBundle

Returns the “default value” for a type.

impl Eq for SourceBundle

impl PartialEq for SourceBundle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SourceBundle