Net::FTPServer::DirHandle

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index

NAME

Net::FTPServer::DirHandle - A Net::FTPServer directory handle.

SYNOPSIS

  use Net::FTPServer::DirHandle;

METHODS

$dirh = new Net::FTPServer::DirHandle ($ftps);

Create a new directory handle. The directory handle corresponds to ``/''.

$dirh = $dirh->parent;

Return the parent directory of the directory $dirh. If the directory is already ``/'', this returns the same directory handle.

$rv = $dirh->is_root;

Return true if the current directory is the root directory.

$handle = $dirh->get ($filename);

Return the file or directory $handle corresponding to the file $filename in directory $dirh. If there is no file or subdirectory of that name, then this returns undef.

$ref = $dirh->list ([$wildcard]);

Return a list of the contents of directory $dirh. The list returned is a reference to an array of pairs:

  [ $filename, $handle ]

The list returned does not include ``.'' or ``..''.

The list is sorted into alphabetical order automatically.

$ref = $dirh->_list_status ([$wildcard]);

Just a dumb wrapper function. Returns the same thing as list_status(), but also includes the special directories ``.'' and ``..'' if no wildcard is specified.

$ref = $dirh->list_status ([$wildcard]);

Return a list of the contents of directory $dirh and status information. The list returned is a reference to an array of triplets:

  [ $filename, $handle, $statusref ]

where $statusref is the tuple returned from the "status" method (see Net::FTPServer::Handle).

The list returned does not include ``.'' or ``..''.

The list is sorted into alphabetical order automatically.

$rv = $dirh->delete;

Delete the current directory. If the delete command was successful, then return 0, else if there was an error return -1.

It is normally only possible to delete a directory if it is empty.

$rv = $dirh->mkdir ($name);

Create a subdirectory called $name within the current directory $dirh.

$file = $dirh->open ($filename, "r"|"w"|"a");

Open or create a file called $filename in the current directory, opening it for either read, write or append. This function returns a "IO::File" handle object.

AUTHORS

Richard Jones (rich@annexia.org).

Net::FTPServer::DirHandle

NAME

SYNOPSIS

METHODS

AUTHORS

COPYRIGHT

SEE ALSO

Index