/*

[0] Fix | Delete

* Copyright (C) the libgit2 contributors. All rights reserved.

[1] Fix | Delete

*

[2] Fix | Delete

* This file is part of libgit2, distributed under the GNU GPL v2 with

[3] Fix | Delete

* a Linking Exception. For full terms see the included COPYING file.

[4] Fix | Delete

*/

[5] Fix | Delete

#ifndef INCLUDE_git_refdb_h__

[6] Fix | Delete

#define INCLUDE_git_refdb_h__

[7] Fix | Delete

[8] Fix | Delete

#include "common.h"

[9] Fix | Delete

#include "types.h"

[10] Fix | Delete

#include "oid.h"

[11] Fix | Delete

#include "refs.h"

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* @file git2/refdb.h

[15] Fix | Delete

* @brief Git custom refs backend functions

[16] Fix | Delete

* @defgroup git_refdb Git custom refs backend API

[17] Fix | Delete

* @ingroup Git

[18] Fix | Delete

* @{

[19] Fix | Delete

*/

[20] Fix | Delete

GIT_BEGIN_DECL

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Create a new reference database with no backends.

[24] Fix | Delete

*

[25] Fix | Delete

* Before the Ref DB can be used for read/writing, a custom database

[26] Fix | Delete

* backend must be manually set using `git_refdb_set_backend()`

[27] Fix | Delete

*

[28] Fix | Delete

* @param out location to store the database pointer, if opened.

[29] Fix | Delete

* Set to NULL if the open failed.

[30] Fix | Delete

* @param repo the repository

[31] Fix | Delete

* @return 0 or an error code

[32] Fix | Delete

*/

[33] Fix | Delete

GIT_EXTERN(int) git_refdb_new(git_refdb **out, git_repository *repo);

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Create a new reference database and automatically add

[37] Fix | Delete

* the default backends:

[38] Fix | Delete

*

[39] Fix | Delete

* - git_refdb_dir: read and write loose and packed refs

[40] Fix | Delete

* from disk, assuming the repository dir as the folder

[41] Fix | Delete

*

[42] Fix | Delete

* @param out location to store the database pointer, if opened.

[43] Fix | Delete

* Set to NULL if the open failed.

[44] Fix | Delete

* @param repo the repository

[45] Fix | Delete

* @return 0 or an error code

[46] Fix | Delete

*/

[47] Fix | Delete

GIT_EXTERN(int) git_refdb_open(git_refdb **out, git_repository *repo);

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Suggests that the given refdb compress or optimize its references.

[51] Fix | Delete

* This mechanism is implementation specific. For on-disk reference

[52] Fix | Delete

* databases, for example, this may pack all loose references.

[53] Fix | Delete

*/

[54] Fix | Delete

GIT_EXTERN(int) git_refdb_compress(git_refdb *refdb);

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Close an open reference database.

[58] Fix | Delete

*

[59] Fix | Delete

* @param refdb reference database pointer or NULL

[60] Fix | Delete

*/

[61] Fix | Delete

GIT_EXTERN(void) git_refdb_free(git_refdb *refdb);

[62] Fix | Delete

[63] Fix | Delete

/** @} */

[64] Fix | Delete

GIT_END_DECL

[65] Fix | Delete

[66] Fix | Delete

#endif

[67] Fix | Delete

[68] Fix | Delete