Struct cargo_sync_readme::Manifest

pub struct Manifest {
    pub toml: Value,
    pub parent_dir: PathBuf,
}

Fields

toml: Value

parent_dir: PathBuf

Methods

impl Manifest

pub fn find_manifest<P>(dir: P) -> Result<Self, FindManifestError> where
    P: AsRef<Path>, 

Get the TOML-formatted manifest by looking up the current directory; if not found, go to the parent directory and recursively retry until one is found… eventually.

pub fn entry_point(
    &self,
    prefer_doc_from: Option<PreferDocFrom>
) -> Option<PathBuf>

Get the path to the file we want to take the documentation from.

pub fn readme(&self) -> PathBuf

Extract the path to the readme file from the manifest.

Trait Implementations

impl Debug for Manifest

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

Formats the value using the given formatter.