thodg/libgit2/include/git2/indexer.h

• Show log

  Commit

• Hash : 68bc511a
  Author :
  Date : 2021-11-26T15:14:56
  

  Add documentation about parameter and return value

Download

• include/git2/indexer.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef _INCLUDE_git_indexer_h__
  #define _INCLUDE_git_indexer_h__
  
  #include "common.h"
  #include "types.h"
  #include "oid.h"
  
  GIT_BEGIN_DECL
  
  /** A git indexer object */
  typedef struct git_indexer git_indexer;
  
  /**
   * This structure is used to provide callers information about the
   * progress of indexing a packfile, either directly or part of a
   * fetch or clone that downloads a packfile.
   */
  typedef struct git_indexer_progress {
  	/** number of objects in the packfile being indexed */
  	unsigned int total_objects;
  
  	/** received objects that have been hashed */
  	unsigned int indexed_objects;
  
  	/** received_objects: objects which have been downloaded */
  	unsigned int received_objects;
  
  	/**
  	 * locally-available objects that have been injected in order
  	 * to fix a thin pack
  	 */
  	unsigned int local_objects;
  
  	/** number of deltas in the packfile being indexed */
  	unsigned int total_deltas;
  
  	/** received deltas that have been indexed */
  	unsigned int indexed_deltas;
  
  	/** size of the packfile received up to now */
  	size_t received_bytes;
  } git_indexer_progress;
  
  /**
   * Type for progress callbacks during indexing.  Return a value less
   * than zero to cancel the indexing or download.
   *
   * @param stats Structure containing information about the state of the transfer
   * @param payload Payload provided by caller
   */
  typedef int GIT_CALLBACK(git_indexer_progress_cb)(const git_indexer_progress *stats, void *payload);
  
  /**
   * Options for indexer configuration
   */
  typedef struct git_indexer_options {
  	unsigned int version;
  
  	/** progress_cb function to call with progress information */
  	git_indexer_progress_cb progress_cb;
  
  	/** progress_cb_payload payload for the progress callback */
  	void *progress_cb_payload;
  
  	/** Do connectivity checks for the received pack */
  	unsigned char verify;
  } git_indexer_options;
  
  #define GIT_INDEXER_OPTIONS_VERSION 1
  #define GIT_INDEXER_OPTIONS_INIT { GIT_INDEXER_OPTIONS_VERSION }
  
  /**
   * Initializes a `git_indexer_options` with default values. Equivalent to
   * creating an instance with GIT_INDEXER_OPTIONS_INIT.
   *
   * @param opts the `git_indexer_options` struct to initialize.
   * @param version Version of struct; pass `GIT_INDEXER_OPTIONS_VERSION`
   * @return Zero on success; -1 on failure.
   */
  GIT_EXTERN(int) git_indexer_options_init(
  	git_indexer_options *opts,
  	unsigned int version);
  
  /**
   * Create a new indexer instance
   *
   * @param out where to store the indexer instance
   * @param path to the directory where the packfile should be stored
   * @param mode permissions to use creating packfile or 0 for defaults
   * @param odb object database from which to read base objects when
   * fixing thin packs. Pass NULL if no thin pack is expected (an error
   * will be returned if there are bases missing)
   * @param opts Optional structure containing additional options. See
   * `git_indexer_options` above.
   * @return 0 or an error code.
   */
  GIT_EXTERN(int) git_indexer_new(
  		git_indexer **out,
  		const char *path,
  		unsigned int mode,
  		git_odb *odb,
  		git_indexer_options *opts);
  
  /**
   * Add data to the indexer
   *
   * @param idx the indexer
   * @param data the data to add
   * @param size the size of the data in bytes
   * @param stats stat storage
   * @return 0 or an error code.
   */
  GIT_EXTERN(int) git_indexer_append(git_indexer *idx, const void *data, size_t size, git_indexer_progress *stats);
  
  /**
   * Finalize the pack and index
   *
   * Resolve any pending deltas and write out the index file
   *
   * @param idx the indexer
   * @param stats Stat storage.
   * @return 0 or an error code.
   */
  GIT_EXTERN(int) git_indexer_commit(git_indexer *idx, git_indexer_progress *stats);
  
  /**
   * Get the packfile's hash
   *
   * A packfile's name is derived from the sorted hashing of all object
   * names. This is only correct after the index has been finalized.
   *
   * @param idx the indexer instance
   * @return the packfile's hash. In casewhere the index has not been finalized,
   *	it will be zeroed out.
   */
  GIT_EXTERN(const git_oid *) git_indexer_hash(const git_indexer *idx);
  
  /**
   * Free the indexer and its resources
   *
   * @param idx the indexer to free
   */
  GIT_EXTERN(void) git_indexer_free(git_indexer *idx);
  
  GIT_END_DECL
  
  #endif
  

Download