Gjsify LogoGjsify Logo

An opaque data structure representing String Chunks. It should only be accessed by using the following functions.

record

Hierarchy

  • StringChunk

Index

Constructors

Properties

name: string

Methods

  • clear(): void
  • Frees all strings contained within the #GStringChunk. After calling g_string_chunk_clear() it is not safe to access any of the strings which were contained within it.

    Returns void

  • free(): void
  • Frees all memory allocated by the #GStringChunk. After calling g_string_chunk_free() it is not safe to access any of the strings which were contained within it.

    Returns void

  • insert(string: string): string
  • Adds a copy of string to the #GStringChunk. It returns a pointer to the new copy of the string in the #GStringChunk. The characters in the string can be changed, if necessary, though you should not change anything after the end of the string.

    Unlike g_string_chunk_insert_const(), this function does not check for duplicates. Also strings added with g_string_chunk_insert() will not be searched by g_string_chunk_insert_const() when looking for duplicates.

    Parameters

    • string: string

      the string to add

    Returns string

  • insert_const(string: string): string
  • Adds a copy of string to the #GStringChunk, unless the same string has already been added to the #GStringChunk with g_string_chunk_insert_const().

    This function is useful if you need to copy a large number of strings but do not want to waste space storing duplicates. But you must remember that there may be several pointers to the same string, and so any changes made to the strings should be done very carefully.

    Note that g_string_chunk_insert_const() will not return a pointer to a string added with g_string_chunk_insert(), even if they do match.

    Parameters

    • string: string

      the string to add

    Returns string

  • insert_len(string: string, len: number): string
  • Adds a copy of the first len bytes of string to the #GStringChunk. The copy is nul-terminated.

    Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that string has at least len addressable bytes.

    The characters in the returned string can be changed, if necessary, though you should not change anything after the end of the string.

    Parameters

    • string: string

      bytes to insert

    • len: number

      number of bytes of string to insert, or -1 to insert a nul-terminated string

    Returns string

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