Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

COMMIT_GVARIANT_STRING: string
DIRMETA_GVARIANT_STRING: string
FILEMETA_GVARIANT_STRING: string
MAX_METADATA_SIZE: number

Maximum permitted size in bytes of metadata objects. This is an arbitrary number, but really, no one should be putting humongous data in metadata.

MAX_METADATA_WARN_SIZE: number

Objects committed above this size will be allowed, but a warning will be emitted.

MAX_RECURSION: number

Maximum depth of metadata.

SHA256_DIGEST_LEN: number

Length of a sha256 digest when expressed as raw bytes

SHA256_STRING_LEN: number

Length of a sha256 digest when expressed as a hexadecimal string

SUMMARY_GVARIANT_STRING: string
SUMMARY_SIG_GVARIANT_STRING: string
TIMESTAMP: number

The mtime used for stored files. This was originally 0, changed to 1 for a few releases, then was reverted due to regressions it introduced from users who had been using zero before.

TREE_GVARIANT_STRING: string
WITH_AUTOCLEANUPS: number

Functions

  • checksum_b64_from_bytes(csum: Uint8Array): string
  • checksum_b64_to_bytes(checksum: string): Uint8Array
  • checksum_bytes_peek_validate(bytes: GLib.Variant): Uint8Array
  • checksum_from_bytes(csum: Uint8Array): string
  • checksum_inplace_to_bytes(checksum: string, buf: number): void
  • Convert checksum from a string to binary in-place, without allocating memory. Use this function in hot code paths.

    Parameters

    • checksum: string

      a SHA256 string

    • buf: number

      Output buffer with at least 32 bytes of space

    Returns void

  • checksum_to_bytes(checksum: string): Uint8Array
  • cmp_checksum_bytes(a: number, b: number): number
  • Compare two binary checksums, using memcmp().

    Parameters

    • a: number

      A binary checksum

    • b: number

      A binary checksum

    Returns number

  • commit_get_parent(commit_variant: GLib.Variant): string
  • commit_get_timestamp(commit_variant: GLib.Variant): number
  • A thin wrapper for ostree_content_stream_parse(); this function converts an object content stream back into components.

    Parameters

    • compressed: boolean

      Whether or not the stream is zlib-compressed

    • content_path: Gio.File

      Path to file containing content

    • trusted: boolean

      If %TRUE, assume the content has been validated

    • cancellable: Gio.Cancellable

      Cancellable

    Returns [boolean, Gio.InputStream, Gio.FileInfo, GLib.Variant]

  • A thin wrapper for ostree_content_stream_parse(); this function converts an object content stream back into components.

    Parameters

    • compressed: boolean

      Whether or not the stream is zlib-compressed

    • parent_dfd: number

      Directory file descriptor

    • path: string

      Subpath

    • trusted: boolean

      If %TRUE, assume the content has been validated

    • cancellable: Gio.Cancellable

      Cancellable

    Returns [boolean, Gio.InputStream, Gio.FileInfo, GLib.Variant]

  • The reverse of ostree_raw_file_to_content_stream(); this function converts an object content stream back into components.

    Parameters

    • compressed: boolean

      Whether or not the stream is zlib-compressed

    • input: Gio.InputStream

      Object content stream

    • input_length: number

      Length of stream

    • trusted: boolean

      If %TRUE, assume the content has been validated

    • cancellable: Gio.Cancellable

      Cancellable

    Returns [boolean, Gio.InputStream, Gio.FileInfo, GLib.Variant]

  • hash_object_name(a: object): number
  • Use this function with #GHashTable and ostree_object_name_serialize().

    Parameters

    • a: object

      A #GVariant containing a serialized object

    Returns number

  • parse_refspec(refspec: string): [boolean, string, string]
  • Split a refspec like "gnome-ostree:gnome-ostree/buildmaster" into two parts; out_remote will be set to "gnome-ostree", and out_ref will be "gnome-ostree/buildmaster".

    If refspec refers to a local ref, out_remote will be %NULL.

    Parameters

    • refspec: string

      A "refspec" string

    Returns [boolean, string, string]

  • repo_commit_traverse_iter_cleanup(p: object): void
  • validate_checksum_string(sha256: string): boolean
  • Use this function to see if input strings are checksums.

    Parameters

    • sha256: string

      SHA256 hex string

    Returns boolean

  • validate_rev(rev: string): boolean
  • validate_structureof_checksum_string(checksum: string): boolean
  • validate_structureof_commit(commit: GLib.Variant): boolean
  • Use this to validate the basic structure of commit, independent of any other objects it references.

    Parameters

    • commit: GLib.Variant

      A commit object, %OSTREE_OBJECT_TYPE_COMMIT

    Returns boolean

  • validate_structureof_csum_v(checksum: GLib.Variant): boolean
  • validate_structureof_dirmeta(dirmeta: GLib.Variant): boolean
  • validate_structureof_dirtree(dirtree: GLib.Variant): boolean
  • Use this to validate the basic structure of dirtree, independent of any other objects it references.

    Parameters

    • dirtree: GLib.Variant

      A dirtree object, %OSTREE_OBJECT_TYPE_DIR_TREE

    Returns boolean

  • validate_structureof_file_mode(mode: number): boolean
  • validate_structureof_objtype(objtype: number): boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method