Struct ContentsFile 

pub struct ContentsFile { /* private fields */ }

Represents a Contents file.

A Contents file maps paths to packages. It facilitates lookups of which paths are in which packages.

Internally, paths are stored as String because bulk operations against paths can be expensive due to more expensive comparison/equality checks.

Implementations

impl ContentsFile

pub fn add_package_path(&mut self, path: String, package: String)

Register a path as belonging to a package.

pub fn packages_with_path( &self, path: &str, ) -> Box<dyn Iterator<Item = &str> + '_>

Obtain an iterator of packages having the specified path.

pub fn package_paths( &self, package: &str, ) -> Box<dyn Iterator<Item = &str> + '_>

Obtain an iterator of paths in a given package.

pub fn as_lines(&self) -> impl Iterator<Item = String> + '_

Emit lines constituting this file.

pub fn write_to(&self, writer: &mut impl Write) -> Result<usize>

Write the content of this file to a writer.

Returns the total number of bytes written.

Trait Implementations

impl Clone for ContentsFile

fn clone(&self) -> ContentsFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentsFile

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

Formats the value using the given formatter.

impl Default for ContentsFile

fn default() -> ContentsFile

Returns the “default value” for a type.