GLib-2.0 ▶ GLib ▶ MappedFile

constructor

• new MappedFile(filename: string, writable: boolean): GLib.MappedFile

  Parameters

  • filename: string
  • writable: boolean

  Returns GLib.MappedFile

Static$gtype

free

• free(): void

  This call existed before GLib.MappedFile had refcounting and is currently exactly the same as g_mapped_file_unref().

  Returns void

get_bytes

• get_bytes(): GLib.Bytes

  Creates a new GLib.Bytes which references the data mapped from file. The mapped contents of the file must not be modified after creating this bytes object, because a GLib.Bytes should be immutable.

  Returns GLib.Bytes

  A newly allocated GLib.Bytes referencing data from file

get_contents

• get_contents(): string

  Returns the contents of a GLib.MappedFile.

  Note that the contents may not be zero-terminated, even if the GLib.MappedFile is backed by a text file.

  If the file is empty then null is returned.

  Returns string

  the contents of file, or null.

get_length

• get_length(): number

  Returns the length of the contents of a GLib.MappedFile.

  Returns number

  the length of the contents of file.

ref

• ref(): GLib.MappedFile

  Increments the reference count of file by one. It is safe to call this function from any thread.

  Returns GLib.MappedFile

  the passed in GLib.MappedFile.

unref

• unref(): void

  Decrements the reference count of file by one. If the reference count drops to 0, unmaps the buffer of file and frees it.

  It is safe to call this function from any thread.

  Since 2.22

  Returns void

Staticnew

• new(filename: string, writable: boolean): GLib.MappedFile

  Parameters

  • filename: string
  • writable: boolean

  Returns GLib.MappedFile

Staticnew_from_fd

• new_from_fd(fd: number, writable: boolean): GLib.MappedFile

  Parameters

  • fd: number
  • writable: boolean

  Returns GLib.MappedFile