nstream Namespace Reference

Classes
class	Stream
	an instance of a read-only stream More...
class	Entry
	a generic entry in the namespace. This is either a Folder or File More...
class	File
	an atom in the namespace: a File is a named object from which you can request read-only streams. More...
class	Folder
	a folder in the namespace: contains other stream::Entry objects. More...
class	Manager
	the object that manages a particular space of named streams More...
Typedefs
typedef eIterationFlag(*	visit_entry_fn )(IN Entry *entry, IN void *context)
	callback for nstream::walkChildFolders()
Enumerations
enum	eIterationFlag {   eIterate_Continue = 1,   eIterate_Stop = 2,   eIterate_Invalid = 0 }
	used by nstream::walkChildFolders() callback More...
Functions
static smart_ptr< Entry >	getEntryForName (IN const char *name, IN const char *rootDir)
static std::string	getFullPath (IN const char *rootDir, IN const char *name)
smart_ptr< Manager >	getFilesystemManager (IN const char *root_dir)
	A reference nstream::Manager implementation: this API provides a namespace object based on the local filesystem.
static eIterationFlag	maybeVisit (IN Entry *entry, IN visit_entry_fn callback, IN void *context, IN const SetString *extensions, IN const char *filter, IN bool visitHidden)
smart_ptr< Stream >	getStreamRelativeTo (IN Stream *startStream, IN const char *relativePath)
	Helper method: given a Stream object, and a path relative to that stream path, return a stream for that.
smart_ptr< Stream >	openNamedStream (IN Manager *mgr, IN const char *name)
	Helper method: open a Stream for a given path on the specified Manager.
std::string	getStreamName (IN Stream *stream)
	Helper method: given a Stream, return its name.
eIterationFlag	walkChildFolders (IN Folder *root, IN visit_entry_fn callback, IN void *context, IN const SetString *extensions=NULL, IN const char *filter=NULL, IN bool visitHidden=false)
	helper methods: given a Folder, walk all child Folders and Entries recursively.
static smart_ptr< Entry >	getEntryForName (IN const char *name)
smart_ptr< Manager >	getResourceStreamManager (void)

---

Function Documentation

static smart_ptr< Entry > nstream::getEntryForName	(	IN const char *	name,
		IN const char *	rootDir
	)			[static]

Definition at line 475 of file fs-nstream.cpp.

static std::string nstream::getFullPath	(	IN const char *	rootDir,
		IN const char *	name
	)			[static]

Definition at line 52 of file fs-nstream.cpp.

static eIterationFlag nstream::maybeVisit	(	IN Entry *	entry,
		IN visit_entry_fn	callback,
		IN void *	context,
		IN const SetString *	extensions,
		IN const char *	filter,
		IN bool	visitHidden
	)			[static]

Definition at line 62 of file nstream.cpp.

static smart_ptr< Entry > nstream::getEntryForName

(

IN const char *

name

)

[static]

Definition at line 430 of file restream.cpp.