var searchIndex = {};
searchIndex["clog"] = {"doc":"","items":[[3,"Clog","clog","The base struct used to set options and interact with the library.",null,null],[12,"grep","","The grep search pattern used to find commits we are interested in (Defaults to:\n"^ft|^feat|^fx|^fix|^unk|BREAKING\\'")",0,null],[12,"format","","The format of the commit output from `git log` (Defaults to: "%H%n%s%n%b%n==END==")",0,null],[12,"repo","","The repository used for the base of hyper-links",0,null],[12,"link_style","","The link style to used for commit and issue hyper-links",0,null],[12,"version","","The version tag for the release (Defaults to the short hash of the latest commit)",0,null],[12,"patch_ver","","Whether or not this is a patch version update or not. Patch versions use a lower markdown\nheader (`###` instead of `##` for major and minor releases)",0,null],[12,"subtitle","","The subtitle for the release",0,null],[12,"from","","Where to start looking for commits using a hash (or short hash)",0,null],[12,"to","","Where to stop looking for commits using a hash (or short hash). (Defaults to `HEAD`)",0,null],[12,"changelog","","The file to use as the changelog. (Defaults to `changelog.md`)",0,null],[12,"section_map","","Maps out the sections and aliases used to trigger those sections. The keys are the section\nname, and the values are an array of aliases.",0,null],[12,"git_dir","","The git dir with all the meta-data (Typically the `.git` sub-directory of the project)",0,null],[12,"git_work_tree","","The working directory of the git project (typically the project directory, or parent of the\n`.git` directory)",0,null],[3,"LogWriter","","Writes commits to a specified `Write` object",null,null],[3,"SectionMap","","A struct which holds sections to and components->commits map",null,null],[12,"sections","","",1,null],[4,"LinkStyle","","",null,null],[13,"Github","","",2,null],[13,"Gitlab","","",2,null],[13,"Stash","","",2,null],[0,"git","","",null,null],[3,"Commit","clog::git","The struct representation of a `Commit`",null,null],[12,"hash","","The 40 char hash",3,null],[12,"subject","","The commit subject",3,null],[12,"component","","The component (if any)",3,null],[12,"closes","","Any issues this commit closes",3,null],[12,"breaks","","Any issues this commit breaks",3,null],[12,"commit_type","","The commit type (or alias)",3,null],[6,"Commits","","A convienience type for multiple commits",null,null],[11,"clone","","",3,null],[11,"fmt","","",3,null],[11,"new","clog","Creates a new instance of the LogWriter using a `Write` object and a `Clog` object as the\nconfiguration options to use while writing.",4,{"inputs":[{"name":"t"},{"name":"clog"}],"output":{"name":"logwriter"}}],[11,"write_header","","Writes the initial header inforamtion for a release",4,null],[11,"write_section","","Writes a particular section of a changelog",4,null],[11,"write","","Writes some contents to the `Write` writer object",4,null],[11,"from_commits","","Creates a section map from a vector of commits, which we can then iterate through and write",1,{"inputs":[{"name":"vec"}],"output":{"name":"sectionmap"}}],[11,"fmt","","",2,null],[11,"from_str","","",2,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"fmt","","",2,null],[11,"variants","","",2,null],[11,"issue_link","","Gets a link to an issue in the specified format.",2,null],[11,"commit_link","","Gets a link to an commit in the specified format.",2,null],[11,"fmt","","",0,null],[11,"new","","Creates a default `Clog` struct using the current working directory and searches for the\ndefault `.clog.toml` configuration file.",0,{"inputs":[],"output":{"name":"clogresult"}}],[11,"with_all","","Creates a `Clog` struct using a specific git working directory and project directory as\nwell as a custom named TOML configuration file.",0,{"inputs":[{"name":"p"},{"name":"p"},{"name":"p"}],"output":{"name":"clogresult"}}],[11,"with_dir_and_file","","Creates a `Clog` struct using a specific git working directory OR project directory as\nwell as a custom named TOML configuration file.",0,{"inputs":[{"name":"p"},{"name":"p"}],"output":{"name":"clogresult"}}],[11,"with_dir","","Creates a `Clog` struct using a specific git working directory OR project directory.\nSearches for the default configuration TOML file `.clog.toml`",0,{"inputs":[{"name":"p"}],"output":{"name":"clogresult"}}],[11,"with_dirs","","Creates a `Clog` struct using a specific git working directory AND a project directory.\nSearches for the default configuration TOML file `.clog.toml`",0,{"inputs":[{"name":"p"},{"name":"p"}],"output":{"name":"clogresult"}}],[11,"from_file","","Creates a `Clog` struct a custom named TOML configuration file. Sets the parent directory\nof the configuration file to the working tree and sibling `.git` directory as the git\ndirectory.",0,{"inputs":[{"name":"p"}],"output":{"name":"clogresult"}}],[11,"from_matches","","Creates a `Clog` struct from command line `clap::ArgMatches`",0,{"inputs":[{"name":"argmatches"}],"output":{"name":"clogresult"}}],[11,"grep","","Sets the grep search pattern for finding commits.",0,null],[11,"format","","Sets the format for `git log` output",0,null],[11,"repository","","Sets the repository used for the base of hyper-links",0,null],[11,"link_style","","Sets the link style to use for hyper-links",0,null],[11,"version","","Sets the version for the release",0,null],[11,"subtitle","","Sets the subtitle for the release",0,null],[11,"from","","Sets how far back to begin searching commits using a short hash or full hash",0,null],[11,"to","","Sets what point to stop searching for commits using a short hash or full hash (Defaults to\n`HEAD`)",0,null],[11,"changelog","","Sets the changelog file to output or prepend to (Defaults to `changelog.md`)",0,null],[11,"git_dir","","Sets the `git` metadata directory (typically `.git` child of your project working tree)",0,null],[11,"git_work_tree","","Sets the `git` working tree directory (typically your project directory)",0,null],[11,"patch_ver","","Sets whether or not this is a patch release (defaults to `false`)",0,null],[11,"get_commits","","Retrieves a `Vec<Commit>` of only commits we care about.",0,null],[11,"get_latest_tag","","Retrieves the latest tag from the git directory",0,null],[11,"get_latest_tag_ver","","Retrieves the latest tag version from the git directory",0,null],[11,"get_last_commit","","Retrieves the hash of the most recent commit from the git directory (i.e. HEAD)",0,null],[11,"section_for","","Retrieves the section title for a given alias",0,null],[11,"write_changelog_to","","Writes the changelog to a specified file, and prepends new commits if file exists, or\ncreates the file if it doesn't",0,null],[11,"write_changelog","","Writes the changelog to the default location and file or wherever was specified by the TOML\nor configuration options. `Clog` prepends new commits if file exists, or\ncreates the file if it doesn't.",0,null]],"paths":[[3,"Clog"],[3,"SectionMap"],[4,"LinkStyle"],[3,"Commit"],[3,"LogWriter"]]};
initSearch(searchIndex);