---

recls/Ruby
[recls]

The recls Ruby mapping. More...

Compounds
class	Entry
	A file object. More...
class	FileSearch
	This class provides file-system searching. More...
class	FtpSearch
	This class provides FTP searching on an internet host. More...
Functions
STRING	usage ()
	Provides a string describing the recls/Ruby mapping API.
Entry	stat (STRING path, INT flags)
	retrieves the Entry information for the given path/flags
Constants
STRING	RECLS_VERSION
	The recls version from which this Ruby mapping was made.
STRING	VERSION
	The version of this Ruby mapping.
INT	FILES
	Include files in search.
INT	DIRECTORIES
	Include directories in search.
INT	LINKS
	Include links in search.
INT	DEVICES
	Include devices in search.
INT	RECURSIVE
	Searches given directory and all sub-directories.
INT	NO_FOLLOW_LINKS
	Does not expand links.
INT	DIRECTORY_PARTS
	Fills out the directory parts.
INT	DETAILS_LATER
	Does not fill out anything other than the path.
INT	PASSIVE_FTP
	Passive mode in FTP.
Attributes
STRING[]	roots
	returns an array of file system roots (e.g.
STRING	pathNameSeparator
	returns the path-name separator (e.g."/" for UNIX, "\" for Windows)
STRING	wildcardsAll
	returns the \"all\" wildcards string (e.g."*" for UNIX, "*.*" for Windows)

---

Detailed Description

The recls Ruby mapping.

This mapping contains the classes - FileSearch FtpSearch and Entry - which provide a Ruby object model wrapping over the recls API, handling resource management, and providing easy-to-use object access to the search results.

---

Function Documentation

Entry stat (  STRING    path, INT    flags )

retrieves the Entry information for the given path/flags

STRING usage (    )

Provides a string describing the recls/Ruby mapping API.

---

Variable Documentation

INT DETAILS_LATER

Does not fill out anything other than the path.

INT DEVICES

Include devices in search. Not currently supported

INT DIRECTORIES

Include directories in search.

INT DIRECTORY_PARTS

Fills out the directory parts. Supported from version 1.1.1 onwards

INT FILES

Include files in search. Included by default if none specified

INT LINKS

Include links in search. Ignored in Win32

INT NO_FOLLOW_LINKS

Does not expand links.

INT PASSIVE_FTP

Passive mode in FTP. Supported from version 1.5.1 onwards

STRING pathNameSeparator

returns the path-name separator (e.g."/" for UNIX, "\" for Windows)

STRING RECLS_VERSION

The recls version from which this Ruby mapping was made.

INT RECURSIVE

Searches given directory and all sub-directories.

STRING [] roots

returns an array of file system roots (e.g. "/" for UNIX, { "C:\", "H:\", ... } for Windows

STRING VERSION

The version of this Ruby mapping.

STRING wildcardsAll

returns the \"all\" wildcards string (e.g."*" for UNIX, "*.*" for Windows)

recls Library documentation © Synesis Software Pty Ltd, 2001-2005