net::sftp::foreign::attributes(3pm) [debian man page]
Net::SFTP::Foreign::Attributes(3pm) User Contributed Perl Documentation Net::SFTP::Foreign::Attributes(3pm)NAME
Net::SFTP::Foreign::Attributes - File/directory attribute container
SYNOPSIS
use Net::SFTP::Foreign;
my $a1 = Net::SFTP::Foreign::Attributes->new();
$a1->set_size($size);
$a1->set_ugid($uid, $gid);
my $a2 = $sftp->stat($file)
or die "remote stat command failed: ".$sftp->status;
my $size = $a2->size;
my $mtime = $a2->mtime;
DESCRIPTION
Net::SFTP::Foreign::Attributes encapsulates file/directory attributes for Net::SFTP::Foreign. It also provides serialization and
deserialization methods to encode/decode attributes into Net::SFTP::Foreign::Buffer objects.
USAGE
Net::SFTP::Foreign::Attributes->new()
Returns a new "Net::SFTP::Foreign::Attributes" object.
Net::SFTP::Foreign::Attributes->new_from_buffer($buffer)
Creates a new attributes object and populates it with information read from $buffer.
$attrs->as_buffer
Serializes the Attributes object $attrs into a buffer object.
$attrs->flags
returns the value of the flags field.
$attrs->size
returns the values of the size field or undef if it is not set.
$attrs->uid
returns the value of the uid field or undef if it is not set.
$attrs->gid
returns the value of the gid field or undef if it is not set.
$attrs->perm
returns the value of the permissions field or undef if it is not set.
See also "stat" in perlfunc for instructions on how to process the returned value with the Fcntl module.
For instance, the following code checks if some attributes object corresponds to a directory:
use Fctnl qw(S_ISDIR);
...
if (S_ISDIR($attr->perm)) {
# it is a directory!
}
$attrs->atime
returns the value of the atime field or undef if it is not set.
$attrs->mtime
returns the value of the mtime field or undef if it is not set.
%extended = $attr->extended
returns the vendor-dependent extended attributes
$attrs->set_size($size)
sets the value of the size field, or if $size is undef removes the field. The flags field is adjusted accordingly.
$attrs->set_perm($perm)
sets the value of the permsissions field or removes it if the value is undefined. The flags field is also adjusted.
$attr->set_ugid($uid, $gid)
sets the values of the uid and gid fields, or removes them if they are undefined values. The flags field is adjusted.
This pair of fields can not be set separatelly because they share the same bit on the flags field and so both have to be set or not.
$attr->set_amtime($atime, $mtime)
sets the values of the atime and mtime fields or remove them if they are undefined values. The flags field is also adjusted.
$attr->set_extended(%extended)
sets the vendor-dependent extended attributes
$attr->append_extended(%more_extended)
adds more pairs to the list of vendor-dependent extended attributes
COPYRIGHT
Copyright (c) 2006-2008 Salvador Fandin~o.
All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.14.2 2012-05-11 Net::SFTP::Foreign::Attributes(3pm)
Check Out this Related Man Page
Net::SSH2::SFTP(3pm) User Contributed Perl Documentation Net::SSH2::SFTP(3pm)NAME
Net::SSH2::SFTP - SSH 2 Secure FTP object
DESCRIPTION
An SFTP object is created by the Net::SSH2 "sftp" method.
error
Returns the last SFTP error (one of the LIBSSH2_FX_* constants). Use this when Net::SSH2::error returns LIBSSH2_ERROR_SFTP_PROTOCOL. In
list context, returns (code, error name).
open ( file [, flags [, mode ]]] )
Open or create a file on the remote host. The flags are the standard O_RDONLY, O_WRONLY, O_RDWR, O_APPEND, O_CREAT, O_TRUNC, and O_EXCL,
which may be combined as usual. Flags default to O_RDONLY and mode to 0666 (create only). Returns a Net::SSH2::File object on success.
opendir ( dir )
Open a directory on the remote host; returns a Net::SSH2::Dir object on success.
unlink ( file )
Delete the remote file.
rename ( old, new [, flags ] )
Rename old to new. Flags are taken from LIBSSH2_SFTP_RENAME_*, and may be combined; the default is to use all (overwrite, atomic, native).
mkdir ( path [, mode ] )
Create directory; mode defaults to 0777.
rmdir ( path )
Remove directory.
stat ( path [, follow ] )
Get file attributes for the given path. If follow is set (default), will follow symbolic links. On success, returns a hash containing the
following:
mode
size
uid
gid
atime
mtime
setstat ( path, key, value... )
Set file attributes for given path; keys are the same as those returned by stat; note that it's not necessary to pass them all.
symlink ( path, target [, type ] )
Create a symbolic link to a given target.
readlink ( path )
Return the target of the given link, undef on failure.
realpath ( path )
Resolve a filename's path; returns the resolved path, or undef on error.
SEE ALSO
Net::SSH2.
AUTHOR
David B. Robins, <dbrobins@cpan.org>
COPYRIGHT AND LICENSE
Copyright (C) 2005, 2006 by David B. Robins; all rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or,
at your option, any later version of Perl 5 you may have available.
perl v5.14.2 2011-05-06 Net::SSH2::SFTP(3pm)