Struct Bootstrap

pub struct Bootstrap { /* private fields */ }

a command installer

Implementations

impl Bootstrap

pub fn new<P: AsRef<OsStr>>(name: &str, cli: Command, outdir: P) -> Self

pub fn completions(&self) -> Result<(), Box<dyn Error>>

Generates and installs shell completions for all supported shells into dir.

Examples

To install shell completions under /usr:

use package_bootstrap::Bootstrap;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    Bootstrap::new("foo", clap::Command::new("foo"), "/usr")
        .completions()?;
    Ok(())
}

To install into a staging directory for packaging purposes:

use package_bootstrap::Bootstrap;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    Bootstrap::new("foo", clap::Command::new("foo"), "staging/usr")
        .completions()?;
    Ok(())
}

pub fn translations<P: AsRef<Path>>( &self, podir: P, ) -> Result<(), Box<dyn Error>>

Compiles and installs translations into /share/locale using the msgfmt external utility.

pub fn docfiles<P: AsRef<Path> + AsRef<OsStr>>( &self, files: &[P], doc_subdir: &Path, ) -> Result<(), Box<dyn Error>>

Copies a slice of files to a documentation subdirectory.

Example

Copy this crate’s README and LICENSE files into /share/doc/foo

use package_bootstrap::Bootstrap;
use std::error::Error;
use std::path::Path;

fn main() -> Result<(), Box<dyn Error>> {
    Bootstrap::new("foo", clap::Command::new("foo"), "pkg/usr")
        .docfiles(&["README.md", "LICENSE.md"], &Path::new("foo"))?;
    Ok(())
}

pub fn install(&self, target_dir: Option<String>) -> Result<(), Box<dyn Error>>

Installs this crate’s binary into /bin. If the “mangen” feature is enabled, also generates and installs the program’s manpage.