summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2021-11-29 13:44:42 -0500
committerEdward Thomson <ethomson@edwardthomson.com>2021-11-30 22:45:13 -0500
commit9f03ebd14b6beb00a9bed52c0568a13f8d5ebb08 (patch)
treedcec3efee630f9c38e15433302e5c6faec65e517 /include
parentfc1a3f456540dfc4dc143b322b943a4264658d56 (diff)
downloadlibgit2-9f03ebd14b6beb00a9bed52c0568a13f8d5ebb08.tar.gz
object: introduce a raw content validation functionethomson/object_validation
Users may want to validate raw object content; provide them a function to do so.
Diffstat (limited to 'include')
-rw-r--r--include/git2/object.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/include/git2/object.h b/include/git2/object.h
index 984dbb7ac..dbf480ed6 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -224,6 +224,28 @@ GIT_EXTERN(int) git_object_peel(
*/
GIT_EXTERN(int) git_object_dup(git_object **dest, git_object *source);
+/**
+ * Analyzes a buffer of raw object content and determines its validity.
+ * Tree, commit, and tag objects will be parsed and ensured that they
+ * are valid, parseable content. (Blobs are always valid by definition.)
+ * An error message will be set with an informative message if the object
+ * is not valid.
+ *
+ * @warning This function is experimental and its signature may change in
+ * the future.
+ *
+ * @param valid Output pointer to set with validity of the object content
+ * @param buf The contents to validate
+ * @param len The length of the buffer
+ * @param type The type of the object in the buffer
+ * @return 0 on success or an error code
+ */
+GIT_EXTERN(int) git_object_rawcontent_is_valid(
+ int *valid,
+ const char *buf,
+ size_t len,
+ git_object_t type);
+
/** @} */
GIT_END_DECL