Class: Net::SFTP::Protocol::V06::Attributes

### Home Classes Methods

### In Files

- lib/net/sftp/protocol/06/attributes.rb

### Parent

Net::SFTP::Protocol::V04::Attributes

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- Net
- Net::SFTP
- Net::SFTP::Constants
- Net::SFTP::Constants::ACE
- Net::SFTP::Constants::ACE::Flag
- Net::SFTP::Constants::ACE::Mask
- Net::SFTP::Constants::ACE::Type
- Net::SFTP::Constants::LockTypes
- Net::SFTP::Constants::OpenFlags
- Net::SFTP::Constants::OpenFlags::FV1
- Net::SFTP::Constants::OpenFlags::FV5
- Net::SFTP::Constants::OpenFlags::FV6
- Net::SFTP::Constants::PacketTypes
- Net::SFTP::Constants::RenameFlags
- Net::SFTP::Constants::StatusCodes
- Net::SFTP::Exception
- Net::SFTP::Operations
- Net::SFTP::Operations::Dir
- Net::SFTP::Operations::Download
- Net::SFTP::Operations::File
- Net::SFTP::Operations::FileFactory
- Net::SFTP::Operations::Upload
- Net::SFTP::Packet
- Net::SFTP::Protocol
- Net::SFTP::Protocol::Base
- Net::SFTP::Protocol::V01
- Net::SFTP::Protocol::V01::Attributes
- Net::SFTP::Protocol::V01::Base
- Net::SFTP::Protocol::V01::Name
- Net::SFTP::Protocol::V02
- Net::SFTP::Protocol::V02::Base
- Net::SFTP::Protocol::V03
- Net::SFTP::Protocol::V03::Base
- Net::SFTP::Protocol::V04
- Net::SFTP::Protocol::V04::Attributes
- Net::SFTP::Protocol::V04::Base
- Net::SFTP::Protocol::V04::Name
- Net::SFTP::Protocol::V05
- Net::SFTP::Protocol::V05::Base
- Net::SFTP::Protocol::V06
- Net::SFTP::Protocol::V06::Attributes
- Net::SFTP::Protocol::V06::Base
- Net::SFTP::Request
- Net::SFTP::Response
- Net::SFTP::Session
- Net::SFTP::StatusException
- Net::SFTP::Version
- Net::SSH
- Net::SSH::Connection
- Net::SSH::Connection::Session

No matching classes.

# Net::SFTP::Protocol::V06::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 6 and higher of the SFTP protocol.

To specify new attributes, just 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)

- :allocation_size | the actual number of bytes that the item uses on disk (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)

- :ctime | the time that the file's attributes were last changed (integer)

- :ctime_nseconds | the nanosecond component of ctime (integer)

- :acl | an array of ACL entries for the item

- :attrib_bits | other attributes of the file or directory (as a bit field) (integer)

- :attrib_bits_valid | a mask describing which bits in attrib_bits are valid (integer)

- :text_hint | whether the file may or may not contain textual data (integer)

- :mime_type | the mime type of the file (string)

- :link_count | the hard link count of the file (integer)

- :untranslated_name | the value of the filename before filename translation was attempted (string)

- :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

F_ALLOCATION_SIZE
F_BITS
F_CTIME
F_LINK_COUNT
F_MIME_TYPE
F_TEXT_HINT
F_UNTRANSLATED_NAME

### Attributes

allocation_size[RW]

The size on-disk of the file

attrib_bits[RW]

Other attributes of this file or directory (as a bit field)

attrib_bits_valid[RW]

A bit mask describing which bits in attrib_bits are valid

ctime[RW]

The time at which the file's attributes were last changed

ctime_nseconds[RW]

The nanosecond component of ctime

link_count[RW]

The hard link count for the file

mime_type[RW]

The mime-type of the file

text_hint[RW]

Describes whether the file may or may not contain textual data

untranslated_name[RW]

The value of the file name before filename translation was attempted

[Validate]

Generated with the Darkfish Rdoc Generator 2.