Struct cargo_sync_readme::Manifest

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

The project manifest.

This type is used internally to retrieve various metadata on your project. The most important information for us is the readme field, which allows us to know which file we need to synchronize.

Fields

toml: Value

Deserialized manifest.

parent_dir: PathBuf

Path on the file system where the manifest exists.

Implementations

impl Manifest

pub fn load(path: impl AsRef<Path>) -> Result<Self, FindManifestError>

Load a manifest from the file system.

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

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

pub fn crate_name(&self) -> Option<&str>

Extract the path to the crate name from the manifest.

pub fn readme(&self) -> PathBuf

Extract the path to the readme file from the manifest.

If the readme doesn’t exist, assume README.md.

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

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

Trait Implementations

impl Debug for Manifest

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

Formats the value using the given formatter.