/ 
Net-SFTP-0.11
River stage one • 1 direct dependent • 1 total dependent
/ Net::SFTP::Attributes

NAME

Net::SFTP::Attributes - File/directory attribute container

SYNOPSIS

use Net::SFTP::Attributes;
my $attrs = Net::SFTP::Attributes->new(Stat => [ stat "foo" ]);
my $size = $attrs->size;

DESCRIPTION

Net::SFTP::Attributes encapsulates file/directory attributes for Net::SFTP. It also provides serialization and deserialization methods to encode/decode attributes into Net::SFTP::Buffer objects.

USAGE

Net::SFTP::Attributes->new( [ %args ] )

Constructs a new Net::SFTP::Attributes object and returns that object.

%args is optional; if not provided the object will be initialized with the default values. If provided, %args can contain:

  • Stat

    A reference to the return value of the built-in stat function. The values in the Net::SFTP::Attributes object will be initialized from the values in the stat array, and the flags will be set appropriately.

  • Buffer

    A Net::SFTP::Buffer object containing a serialized attribute object. The Net::SFTP::Attributes object will be initialized from the values in the serialized string, and flags will be set appropriately.

$attrs->as_buffer

Serializes the Attributes object $attrs into string form, using the flags in the object to determine what fields get placed in the buffer. Returns a Net::SFTP::Buffer object.

$attrs->flags( [ $value ] )

Get/set the value of the flags in $attrs.

$attrs->size( [ $value ] )

Get/set the value of the file size (in bytes) in $attrs.

$attrs->uid( [ $value ] )

Get/set the value of the UID in $attrs.

$attrs->gid( [ $value ] )

Get/set the value of the GID in $attrs.

$attrs->perm( [ $value ] )

Get/set the value of the permissions in $attrs.

$attrs->atime( [ $value ] )

Get/set the value of the last access time (atime) in $attrs.

$attrs->mtime( [ $value ] )

Get/set the value of the last modified time (mtime) in $attrs.

AUTHOR & COPYRIGHTS

Please see the Net::SFTP manpage for author, copyright, and license information.