Crate bugreport

source ·
Expand description

bugreport is a library that helps application developers to automatically collect information about the system and the environment that users can send along with a bug report (similar to git bugreport or ffmpeg … -report).

Usage example:

use bugreport::{bugreport, collector::*, format::Markdown};

bugreport!()
    .info(SoftwareVersion::default())
    .info(OperatingSystem::default())
    .info(CommandLine::default())
    .info(EnvironmentVariables::list(&["SHELL", "EDITOR"]))
    .info(CommandOutput::new("Python version", "python", &["--version"]))
    .info(CompileTimeInformation::default())
    .print::<Markdown>();

Modules

  • collector
    Contains all builtin information collectors and the Collector trait to implement your own.
  • format
    Different formats for printing the report.
  • report
    Defines the document structure of the report. Only needed for custom collectors.

Macros

  • bugreport
    Generate a new BugReport object.
  • git_version
    Re-export so dependent project does not have to manually depend on git-version crate Get the git version for the source code.

Structs

  • BugReport
    The main struct for collecting bug report information.