ri > Net::SFTP::Protocol::V04::Attributes

Net::SFTP::Protocol::V04::Attributes < Net::SFTP::Protocol::V01::Attributes

📛 NAME

Net::SFTP::Protocol::V04::Attributes — A class representing the attributes of a file or directory on the server. It may be used to specify new attributes, or to query existing attributes. This particular class is specific to versions 4 and 5 of the SFTP protocol.

🚀 Quick Reference

📖 DESCRIPTION

To specify new attributes, pass a hash as the argument to the constructor. The following keys are supported:

• :type — the type of the item (integer, one of the T_ constants)
• :size — the size of the item (integer)
• :uid — the user-id that owns the file (integer)
• :gid — the group-id that owns the file (integer)
• :owner — the name of the user that owns the file (string)
• :group — the name of the group that owns the file (string)
• :permissions — the permissions on the file (integer, e.g. 0755)
• :atime — the access time of the file (integer, seconds since epoch)
• :atime_nseconds — the nanosecond component of atime (integer)
• :createtime — the time at which the file was created (integer, seconds since epoch)
• :createtime_nseconds — the nanosecond component of createtime (integer)
• :mtime — the modification time of the file (integer, seconds since epoch)
• :mtime_nseconds — the nanosecond component of mtime (integer)
• :acl — an array of ACL entries for the item
• :extended — a hash of name/value pairs identifying extended info

Likewise, when the server sends an Attributes object, all of the above attributes are exposed as methods (though not all will be set with non‑nil values from the server).

🔢 Constants

• ACL — A simple struct for representing a single entry in an Access Control List. (See Net::SFTP::Constants::ACE)
• F_ACCESSTIME — [not documented]
• F_ACL — [not documented]
• F_CREATETIME — [not documented]
• F_MODIFYTIME — [not documented]
• F_OWNERGROUP — [not documented]
• F_SUBSECOND_TIMES — [not documented]

🛠️ Class Methods

• new — Construct a new Attributes object (pass a hash as described above).

🔧 Instance Methods

• acl — Returns the ACL array.
• atime_nseconds — Returns the nanosecond component of atime.
• createtime — Returns the creation time (seconds since epoch).
• createtime_nseconds — Returns the nanosecond component of createtime.
• group — Returns the group name (string).
• mtime_nseconds — Returns the nanosecond component of mtime.
• owner — Returns the owner name (string).
• type — Returns the file type (one of the T_ constants).

📦 Attributes

• attr_accessor acl — Read/write access to ACL.
• attr_accessor atime_nseconds — Read/write nanosecond atime.
• attr_accessor createtime — Read/write creation time.
• attr_accessor createtime_nseconds — Read/write nanosecond createtime.
• attr_accessor mtime_nseconds — Read/write nanosecond mtime.
• attr_accessor type — Read/write file type.
• attr_writer group — Write‑only group name.
• attr_writer owner — Write‑only owner name.