Struct BundleContents 

pub struct BundleContents {
    pub files: Vec<BundleFile>,
    pub unreadable: Vec<String>,
}

What a bundle carries that is not one of its concepts.

Fields

files: Vec<BundleFile>

Every non-markdown file, ordered by path.

unreadable: Vec<String>

Everything the walk could not inspect, so the inventory above is incomplete.

Reported rather than swallowed. An inventory that answers “none” because something would not open is the same false reassurance this feature exists to remove — a reader would take silence for absence, which is precisely what “0 violations” over an unread PDF did.

Three failures land here, not one: a directory that will not list, a directory entry that will not yield, and an entry whose type cannot be read. The first was the obvious case and the other two are the same defect one level in — entries.flatten() and a let Ok(kind) = … else continue each discard an error and leave is_complete() saying the walk saw everything.

A file whose size cannot be read is not here: the file itself was seen, named and reported, so the inventory is complete. See BundleFile::bytes.

Implementations

impl BundleContents

pub fn is_complete(&self) -> bool

Whether the walk saw everything it tried to.

Trait Implementations

impl Clone for BundleContents

fn clone(&self) -> BundleContents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BundleContents

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

Formats the value using the given formatter.

impl Default for BundleContents

fn default() -> BundleContents

Returns the “default value” for a type.

impl Eq for BundleContents

impl PartialEq for BundleContents

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BundleContents

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BundleContents