GITPackIndex Class Reference

#import <GITPackIndex.h>

Inherited by GITPackIndexVersion1, GITPackIndexVersion2, and GITPlaceholderPackIndex.

List of all members.

Public Member Functions
(id)	- copyWithZone:
(NSUInteger)	- version
(id)	- initWithPath:
(id)	- initWithPath:error:
(NSUInteger)	- packOffsetForSha1:
(NSArray *)	- offsets
(NSData *)	- checksum
(NSData *)	- packChecksum
(NSString *)	- checksumString
(NSString *)	- packChecksumString
(BOOL)	- verifyChecksum
(NSUInteger)	- numberOfObjects
(NSUInteger)	- numberOfObjectsWithFirstByte:
(NSRange)	- rangeOfObjectsWithFirstByte:
(BOOL)	- hasObjectWithSha1:

---

Detailed Description

GITPackIndex is a class cluster.

---

Member Function Documentation

- (NSData *) checksum

Returns checksum data for the receiver

Returns:

Checksum data of the receiver

- (NSString *) checksumString

Returns checksum string for the receiver

Returns:

Checksum string of the receiver

- (id) copyWithZone:

(NSZone*)

zone

For internal use only.

- (BOOL) hasObjectWithSha1:

(NSString*)

sha1

Returns YES if the object identified by sha1 exists in the receivers PACK file.

Parameters:

sha1

The name of the object to search for

Returns:

YES if the sha1 exists in the receiver, NO if it doesn't.

- (id) initWithPath:

(NSString*)

path

Creates and returns a new IDX object at the specified path.

Parameters:

path

Path of the IDX file in the repository

Returns:

A new IDX object

For internal use only.

Subclasses must override this method, failure to do so will result in an error. The overriding implementation should not call this implementation as part of itself. Instead it is recommended to use [super init] instead.

- (id) initWithPath:		(NSString*)	thePath
error:		(NSError**)	outError

- (NSUInteger) numberOfObjects

Returns the number of objects in the receivers PACK file

Returns:

Number of objects in the receivers PACK file.

- (NSUInteger) numberOfObjectsWithFirstByte:

(char)

byte

Returns the number of objects whose names (SHA1) begin with the provided first byte.

Parameters:

byte

The byte to get the number of objects for

Returns:

Number of objects starting with byte

- (NSArray *) offsets

Returns an array of the offsets within the receiver where the offset within the associated PACK file can be found.

Returns:

Array of SHA1 offsets within the receiver

For internal use only.

This method is required for some of the derived methods it is much more low level than most code requires.

- (NSData *) packChecksum

Returns checksum data for the pack file of the receiver

Returns:

Checksum data for the pack file of the receiver

- (NSString *) packChecksumString

Returns checksum string for the pack file of the receiver

Returns:

Checksum string for the pack file of the receiver

- (NSUInteger) packOffsetForSha1:

(NSString*)

sha1

Returns the offset within the associated PACK file where the object specified by the given sha1 can be located.

Parameters:

sha1

The SHA1 of the object to return the pack offset for

Returns:

Offset value within the associated PACK file for the SHA1

- (NSRange) rangeOfObjectsWithFirstByte:

(char)

byte

Returns a range describing the number of objects to the beginning of those starting with byte and the number of objects ending with byte.

Parameters:

byte

The byte to get the range of objects for

Returns:

Range describing the objects with the first byte

- (BOOL) verifyChecksum

Verifies if the checksum matches for the contents of the receiver.

Returns:

YES if checksum matches, NO if it does not.

- (NSUInteger) version

Returns the version of IDX file which the receiver is providing access to.

Returns:

Numerical version of the receiver

For internal use only.

Subclasses must override this method

---

The documentation for this class was generated from the following files:

• GITPackIndex.h
• GITPackIndex.m