Module sync

Source
Expand description

sync git api

Re-exports§

pub use blame::blame_file;
pub use blame::BlameHunk;
pub use blame::FileBlame;
pub use branch::branch_compare_upstream;
pub use branch::checkout_branch;
pub use branch::checkout_commit;
pub use branch::config_is_pull_rebase;
pub use branch::create_branch;
pub use branch::delete_branch;
pub use branch::get_branch_remote;
pub use branch::get_branches_info;
pub use branch::merge_commit::merge_upstream_commit;
pub use branch::merge_ff::branch_merge_upstream_fastforward;
pub use branch::merge_rebase::merge_upstream_rebase;
pub use branch::rename::rename_branch;
pub use branch::validate_branch_name;
pub use branch::BranchCompare;
pub use branch::BranchDetails;
pub use branch::BranchInfo;
pub use commit::amend;
pub use commit::commit;
pub use commit::tag_commit;
pub use commit_files::get_commit_files;
pub use diff::get_diff_commit;
pub use remotes::get_default_remote;
pub use remotes::get_default_remote_for_fetch;
pub use remotes::get_default_remote_for_push;
pub use remotes::get_remotes;
pub use status::is_workdir_clean;
pub use utils::get_head;
pub use utils::get_head_tuple;
pub use utils::repo_dir;
pub use utils::repo_open_error;
pub use utils::stage_add_all;
pub use utils::stage_add_file;
pub use utils::stage_addremoved;
pub use utils::Head;

Modules§

blame
Sync git API for fetching a file blame
branch
branch functions
commit
Git Api for Commits
commit_files
Functions for getting infos about files in commits
cred
credentials git helper
diff
sync git api for fetching a diff
remotes
sign
Sign commit data.
status
sync git api for fetching a status
utils
sync git api (various methods)

Structs§

CommitDetails
CommitId
identifies a single commit
CommitInfo
CommitMessage
CommitSignature
LogFilterSearch
LogFilterSearchOptions
LogWalker
SearchFields
SearchOptions
SubmoduleInfo
SubmoduleParentInfo
SubmoduleStatus
Return codes for submodule status.
Tag
TagWithMetadata
TreeFile
tree_files returns a list of FileTree

Enums§

BranchType
An enumeration for the possible types of branches
HookResult
PrepareCommitMsgSource
PushTagsProgress
RepoPath
RepoState
ResetType
An enumeration of the operations that can be performed for the reset method on a Repository.
ShowUntrackedFilesConfig
represents the status.showUntrackedFiles git config state

Traits§

AsyncProgress

Functions§

abort_pending_rebase
abort_pending_state
does these steps:
add_to_ignore
add file or path to root ignore file
commit_revert
continue_pending_rebase
delete_tag
diff_contains_file
discard_lines
discards specific lines in an unstaged hunk of a diff
filter_commit_by_search
get_commit_details
get_commit_info
get_commits_info
get_config_string
get string from config
get_stashes
get_submodules
get_tags
returns Tags type filled with all tags found in repo
get_tags_with_metadata
hooks_commit_msg
this hook is documented here https://git-scm.com/docs/githooks#_commit_msg we use the same convention as other git clients to create a temp file containing the commit message at <.git|hooksPath>/COMMIT_EDITMSG and pass it’s relative path as the only parameter to the hook script.
hooks_post_commit
hooks_pre_commit
this hook is documented here https://git-scm.com/docs/githooks#_pre_commit
hooks_prepare_commit_msg
merge_branch
merge_commit
merge_msg
mergehead_ids
rebase_branch
rebase current HEAD on branch
rebase_progress
repo_state
reset_hunk
this will fail for an all untracked file
reset_repo
reset_stage
reset_workdir
revert_commit
revert_head
reword
This is the same as reword, but will abort and fix the repo if something goes wrong
stage_hunk
stage_lines
stash_apply
stash_drop
stash_pop
stash_save
submodule_parent_info
query whether repo_path points to a repo that is part of a parent git which contains it as a submodule
tree_file_content
will only work on utf8 content
tree_files
guarantees sorting the result
unstage_hunk
untracked_files_config
update_submodule

Type Aliases§

CommitTags
all tags pointing to a single commit
RepoPathRef
SharedCommitFilterFn
Tags
hashmap of tag target commit hash to tag names