Gnome2:...::Handle(3)

📦
version 1.084 · 2 versions
, in fedora 43

💖 NAME 💖

Gnome2::VFS::Handle — bestie, this is your lil' file handle object from the gtk2-perl Gnome2::VFS crew 🫶 it's the thing you hold onto when you wanna read, write, seek around, or just vibe-check a file without caring whether it lives on your disk or on some whole other machine. iykyk 💅

(this page lives in the User Contributed Perl Documentation section, so you know it's the good stuff)

✨ METHODS ✨

okay so here's every single thing a Gnome2::VFS::Handle can do for you, no skips, no cuts, we're going through all of them 💖

  • result = $handle->close — closes the handle, periodt. you get back a result and that's the whole story 🎀
  • list = $handle->get_file_info ($options) — grabs the file info, and it takes one thing:
    • $options — a Gnome2::VFS::FileInfoOptions (that's the flags enum down below, keep scrolling bestie)

it hands you back a GnomeVFSResult and a GnomeVFSFileInfo. two-for-one, iconic ✨

  • result = $handle->forget_cache ($offset, $size) — tells the handle to forget a chunk of its cache. it takes:
    • $offset — an unsigned value
    • $size — an unsigned value

and it gives you back a result.

Since: vfs 2.12 — so if you're on something older, this one's not showing up for you, sorry babe 😭
  • list = $handle->read ($bytes) — the main character of read operations 💅 it takes:
    • $bytes — an unsigned value

and returns a GnomeVFSResult, the number of bytes read, and the buffer containing the read content. three things. she's generous 🎀

  • result = $handle->seek ($whence, $offset) — scoots the file position around. it takes:
    • $whence — a Gnome2::VFS::SeekPosition (start / current / end, see the enums section)
    • $offset — an unsigned value

you get a result back. go where you wanna go bestie 🌈

  • list = $handle->tell — no arguments, she just tells you where you're at 🦋 returns a GnomeVFSResult and the offset. very "where am i in this file" of her.
  • result = $handle->truncate ($length) — chops the file down. it takes:
    • $length — an unsigned value

and returns a result.

  • list = $handle->write ($buffer, $bytes) — the moment we've all been waiting for, writing 💖 it takes:
    • $buffer — a string
    • $bytes — an unsigned value

and returns a GnomeVFSResult and the number of bytes written.

🌸 ENUMS AND FLAGS 🌸

the whole roster, every single one, no gatekeeping 💜

flags Gnome2::VFS::FileInfoOptions

  • 'default' / 'GNOME_VFS_FILE_INFO_DEFAULT'
  • 'get-mime-type' / 'GNOME_VFS_FILE_INFO_GET_MIME_TYPE'
  • 'force-fast-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE'
  • 'force-slow-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE'
  • 'follow-links' / 'GNOME_VFS_FILE_INFO_FOLLOW_LINKS'
  • 'get-access-rights' / 'GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS'
  • 'name-only' / 'GNOME_VFS_FILE_INFO_NAME_ONLY'
  • 'get-acl' / 'GNOME_VFS_FILE_INFO_GET_ACL'
  • 'get-selinux-context' / 'GNOME_VFS_FILE_INFO_GET_SELINUX_CONTEXT'

enum Gnome2::VFS::Result

this is the big one bestie, every result code in the game 🔥

  • 'ok' / 'GNOME_VFS_OK'
  • 'error-not-found' / 'GNOME_VFS_ERROR_NOT_FOUND'
  • 'error-generic' / 'GNOME_VFS_ERROR_GENERIC'
  • 'error-internal' / 'GNOME_VFS_ERROR_INTERNAL'
  • 'error-bad-parameters' / 'GNOME_VFS_ERROR_BAD_PARAMETERS'
  • 'error-not-supported' / 'GNOME_VFS_ERROR_NOT_SUPPORTED'
  • 'error-io' / 'GNOME_VFS_ERROR_IO'
  • 'error-corrupted-data' / 'GNOME_VFS_ERROR_CORRUPTED_DATA'
  • 'error-wrong-format' / 'GNOME_VFS_ERROR_WRONG_FORMAT'
  • 'error-bad-file' / 'GNOME_VFS_ERROR_BAD_FILE'
  • 'error-too-big' / 'GNOME_VFS_ERROR_TOO_BIG'
  • 'error-no-space' / 'GNOME_VFS_ERROR_NO_SPACE'
  • 'error-read-only' / 'GNOME_VFS_ERROR_READ_ONLY'
  • 'error-invalid-uri' / 'GNOME_VFS_ERROR_INVALID_URI'
  • 'error-not-open' / 'GNOME_VFS_ERROR_NOT_OPEN'
  • 'error-invalid-open-mode' / 'GNOME_VFS_ERROR_INVALID_OPEN_MODE'
  • 'error-access-denied' / 'GNOME_VFS_ERROR_ACCESS_DENIED'
  • 'error-too-many-open-files' / 'GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES'
  • 'error-eof' / 'GNOME_VFS_ERROR_EOF'
  • 'error-not-a-directory' / 'GNOME_VFS_ERROR_NOT_A_DIRECTORY'
  • 'error-in-progress' / 'GNOME_VFS_ERROR_IN_PROGRESS'
  • 'error-interrupted' / 'GNOME_VFS_ERROR_INTERRUPTED'
  • 'error-file-exists' / 'GNOME_VFS_ERROR_FILE_EXISTS'
  • 'error-loop' / 'GNOME_VFS_ERROR_LOOP'
  • 'error-not-permitted' / 'GNOME_VFS_ERROR_NOT_PERMITTED'
  • 'error-is-directory' / 'GNOME_VFS_ERROR_IS_DIRECTORY'
  • 'error-no-memory' / 'GNOME_VFS_ERROR_NO_MEMORY'
  • 'error-host-not-found' / 'GNOME_VFS_ERROR_HOST_NOT_FOUND'
  • 'error-invalid-host-name' / 'GNOME_VFS_ERROR_INVALID_HOST_NAME'
  • 'error-host-has-no-address' / 'GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS'
  • 'error-login-failed' / 'GNOME_VFS_ERROR_LOGIN_FAILED'
  • 'error-cancelled' / 'GNOME_VFS_ERROR_CANCELLED'
  • 'error-directory-busy' / 'GNOME_VFS_ERROR_DIRECTORY_BUSY'
  • 'error-directory-not-empty' / 'GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY'
  • 'error-too-many-links' / 'GNOME_VFS_ERROR_TOO_MANY_LINKS'
  • 'error-read-only-file-system' / 'GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM'
  • 'error-not-same-file-system' / 'GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM'
  • 'error-name-too-long' / 'GNOME_VFS_ERROR_NAME_TOO_LONG'
  • 'error-service-not-available' / 'GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE'
  • 'error-service-obsolete' / 'GNOME_VFS_ERROR_SERVICE_OBSOLETE'
  • 'error-protocol-error' / 'GNOME_VFS_ERROR_PROTOCOL_ERROR'
  • 'error-no-master-browser' / 'GNOME_VFS_ERROR_NO_MASTER_BROWSER'
  • 'error-no-default' / 'GNOME_VFS_ERROR_NO_DEFAULT'
  • 'error-no-handler' / 'GNOME_VFS_ERROR_NO_HANDLER'
  • 'error-parse' / 'GNOME_VFS_ERROR_PARSE'
  • 'error-launch' / 'GNOME_VFS_ERROR_LAUNCH'
  • 'error-timeout' / 'GNOME_VFS_ERROR_TIMEOUT'
  • 'error-nameserver' / 'GNOME_VFS_ERROR_NAMESERVER'
  • 'error-locked' / 'GNOME_VFS_ERROR_LOCKED'
  • 'error-deprecated-function' / 'GNOME_VFS_ERROR_DEPRECATED_FUNCTION'
  • 'error-invalid-filename' / 'GNOME_VFS_ERROR_INVALID_FILENAME'
  • 'error-not-a-symbolic-link' / 'GNOME_VFS_ERROR_NOT_A_SYMBOLIC_LINK'
  • 'num-errors' / 'GNOME_VFS_NUM_ERRORS'

enum Gnome2::VFS::SeekPosition

only three, short and sweet, the little icons of the enum world 🎀

  • 'start' / 'GNOME_VFS_SEEK_START'
  • 'current' / 'GNOME_VFS_SEEK_CURRENT'
  • 'end' / 'GNOME_VFS_SEEK_END'

👑 SEE ALSO 👑

  • Gnome2::VFS — go read this one next bestie, it's the parent vibe 🌈

Copyright (C) 2003-2007, 2013 by the gtk2-perl team.

This software is licensed under the LGPL. See Gnome2::VFS for a full notice.

and that's the whole page, bestie, you ate it 💅✨ this lil' slice of the docs was brought to you by perl v5.42.0, dated 2025-07-25 — mwah, love you, go read a file 🦋💖

📦 where this page comes from