Class Patch

Represents a patch object.

record

Hierarchy

Patch

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Patch(): Patch

Returns Patch

Properties

Static name

name: string

Methods

get_delta

get_delta(): DiffDelta

- Defined in @types/Gjs/Ggit-1.0.d.ts:6900
Get the diff delta corresponding to the patch.

Returns DiffDelta

get_hunk

get_hunk(idx: number): DiffHunk

- Defined in @types/Gjs/Ggit-1.0.d.ts:6905
Get the idx'th hunk in the patch.

Parameters
- idx: number
  
  the hunk index.
Returns DiffHunk

get_line_stats

get_line_stats(): [boolean, number, number, number]

- Defined in @types/Gjs/Ggit-1.0.d.ts:6909
Get the line statistics of the patch.

Returns [boolean, number, number, number]

get_num_hunks

get_num_hunks(): number

- Defined in @types/Gjs/Ggit-1.0.d.ts:6913
Get the number of hunks in the patch.

Returns number

get_num_lines_in_hunk

get_num_lines_in_hunk(hunk: number): number

- Defined in @types/Gjs/Ggit-1.0.d.ts:6918
Get the number of lines in hunk.

Parameters
- hunk: number
  
  the hunk index.
Returns number

ref

ref(): Patch

- Defined in @types/Gjs/Ggit-1.0.d.ts:6923
Atomically increments the reference count of patch by one. This function is MT-safe and may be called from any thread.

Returns Patch

to_stream

to_stream(stream: Gio.OutputStream): boolean

- Defined in @types/Gjs/Ggit-1.0.d.ts:6928
Write the contents of a patch to the provided stream.

Parameters
- stream: Gio.OutputStream
  
  a #GOutputStream.
Returns boolean

to_string

to_string(): string

- Defined in @types/Gjs/Ggit-1.0.d.ts:6932
Gets the content of a patch as a single diff text.

Returns string

unref

unref(): void

- Defined in @types/Gjs/Ggit-1.0.d.ts:6937
Atomically decrements the reference count of patch by one. If the reference count drops to 0, patch is freed.

Returns void

Static new_from_blobs

new_from_blobs(old_blob: Ggit.Blob, old_as_path: string, new_blob: Ggit.Blob, new_as_path: string, diff_options: DiffOptions): Patch

- Defined in @types/Gjs/Ggit-1.0.d.ts:6966
Directly generate a patch from the difference between two blobs.

This is just like ggit_diff_blobs() except it generates a patch object for the difference instead of directly making callbacks. You can use the standard ggit_patch accessor functions to read the patch data, and you must call ggit_patch_unref on the patch when done.

Parameters
- old_blob: Ggit.Blob
  
  a #GgitBlob to diff from.
- old_as_path: string
  
  treat old_blob as if it had this filename, or %NULL,
- new_blob: Ggit.Blob
  
  a #GgitBlob to diff to.
- new_as_path: string
  
  treat new_blob as if it had this filename, or %NULL,
- diff_options: DiffOptions
  
  a #GgitDiffOptions, or %NULL.
Returns Patch

Static new_from_diff

new_from_diff(diff: Ggit.Diff, idx: number): Patch

- Defined in @types/Gjs/Ggit-1.0.d.ts:6976
The #GgitPatch is a newly created object contains the text diffs for the delta. You have to call ggit_patch_unref() when you are done with it. You can use the patch object to loop over all the hunks and lines in the diff of the one delta.

Parameters
- diff: Ggit.Diff
  
  a #GgitDiff.
- idx: number
  
  index into diff list.
Returns Patch