Struct readme_sync::Package

pub struct Package { /* fields omitted */ }

A struct contains package manifest and its root path.

Implementations

impl Package

pub fn from_path(path: PathBuf) -> Result<Self, TomlReadError>

Creates a package from the specified path.

pub fn from_manifest_and_path(manifest: Manifest, path: PathBuf) -> Self

Creates a package from the manifest and package path.

pub fn manifest(&self) -> &Manifest

Returns a package manifest.

pub fn path(&self) -> &Path

Returns a package path.

pub fn relative_readme_path(&self) -> Option<&Path>

Returns package relative readme path.

pub fn default_relative_readme_path(&self) -> Option<&Path>

Returns package relative default readme path.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl PartialEq<Package> for Package

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Package

impl StructuralEq for Package

impl StructuralPartialEq for Package