Class OId

Represents a unique ID of any object.

record

Hierarchy

OId

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new OId(): OId

Returns OId

Properties

Static name

name: string

Methods

compare

compare(b: OId): number

- Defined in @types/Gjs/Ggit-1.0.d.ts:6791
Compare two #GgitOId structures.

Parameters
- b: OId
  
  second #GgitOId.
Returns number

copy

copy(): OId

- Defined in @types/Gjs/Ggit-1.0.d.ts:6795
Copies oid into a newly allocated #GgitOId.

Returns OId

equal

equal(b: OId): boolean

- Defined in @types/Gjs/Ggit-1.0.d.ts:6800
Compares two #GgitOId for equality.

Parameters
- b: OId
  
  a #GgitOId.
Returns boolean

free

free(): void

- Defined in @types/Gjs/Ggit-1.0.d.ts:6804
Frees oid.

Returns void

has_prefix

has_prefix(prefix: string): boolean

- Defined in @types/Gjs/Ggit-1.0.d.ts:6810
Check whether the object id has a given prefix. Note that the prefix is specified in hexadecimal ASCII.

Parameters
- prefix: string
  
  a prefix.
Returns boolean

hash

hash(): number

- Defined in @types/Gjs/Ggit-1.0.d.ts:6814
Computes a hash value for a git object identifier.

Returns number

is_zero

is_zero(): boolean

- Defined in @types/Gjs/Ggit-1.0.d.ts:6818
Get whether the oid contains only zeros.

Returns boolean

to_string

to_string(): string

- Defined in @types/Gjs/Ggit-1.0.d.ts:6822
Converts oid into a readable string.

Returns string

Static new_from_raw

new_from_raw(raw: Uint8Array): OId

- Defined in @types/Gjs/Ggit-1.0.d.ts:6842
Creates a new #GgitOId from a raw oid.

Parameters
- raw: Uint8Array
  
  the raw input bytes to be copied.
Returns OId

Static new_from_string

new_from_string(str: string): OId

- Defined in @types/Gjs/Ggit-1.0.d.ts:6848
Parses a hex formatted object id into a #GgitOId.

Parameters
- str: string
  
  input hex string; must be pointing at the start of the hex sequence and have at least the number of bytes needed for an oid encoded in hex (40 bytes).
Returns OId