basic_findfile_sequence_value_type Class Template Reference
[File System Library]

#include <winstl/filesystem/findfile_sequence.hpp>

List of all members.

---

Detailed Description

template<typename C, typename T>
class winstl::basic_findfile_sequence_value_type< C, T >

Value type for the basic_findfile_sequence.

Member Types
typedef C	char_type
	The character type.
typedef T	traits_type
	The traits type.
typedef basic_findfile_sequence_value_type < C, T >	class_type
	The current parameterisation of the type.
typedef traits_type::find_data_type	find_data_type
	The find-data type.
typedef sequence_type::size_type	size_type
	The size type.
Construction
	basic_findfile_sequence_value_type ()
	Default constructor.
class_type &	operator= (class_type const &rhs)
	Copy assignment operator.
Public Member Functions
Accessors
find_data_type const &	get_find_data () const
	Returns a non-mutating reference to find-data.
char_type const *	get_filename () const
	Returns the filename part of the item.
char_type const *	get_short_filename () const
	Returns the short form of the filename part of the item.
char_type const *	get_path () const
	Returns the full path of the item.
char_type const *	c_str () const
	Returns the full path of the item.
size_t	length () const
	Returns the length of the full path.
	operator char_type const * () const
	Implicit conversion to a pointer-to-const of the full path.
bool	is_directory () const
	Indicates whether the entry is a directory.
bool	is_file () const
	Indicates whether the entry is a file.
bool	is_compressed () const
	Indicates whether the entry is compressed.
bool	is_read_only () const
	Indicates whether the entry is read-only.
bool	is_system () const
	Indicates whether the entry is a system file/directory.
bool	is_hidden () const
	Indicates whether the entry is hidden.
Comparison
bool	equal (char_type const *rhs) const
	Determines whether the instance is equal to the given path.
bool	equal (class_type const &rhs) const
	Determines whether two instances are equal.

---

Member Typedef Documentation

typedef C char_type

The character type.

typedef T traits_type

The traits type.

typedef basic_findfile_sequence_value_type<C, T> class_type

The current parameterisation of the type.

typedef traits_type::find_data_type find_data_type

The find-data type.

typedef sequence_type::size_type size_type

The size type.

---

Constructor & Destructor Documentation

basic_findfile_sequence_value_type

(

)

Default constructor.

---

Member Function Documentation

class_type& operator=

(

class_type const &

rhs

)

Copy assignment operator.

find_data_type const& get_find_data

(

)

const

Returns a non-mutating reference to find-data.

char_type const* get_filename

(

)

const

Returns the filename part of the item.

char_type const* get_short_filename

(

)

const

Returns the short form of the filename part of the item.

char_type const* get_path

(

)

const

Returns the full path of the item.

Note:

The path is not canonicalised, so will not be in canonical form if the filename is a dots directory. For this you should use winstl::path, and call canonicalise()

char_type const* c_str

(

)

const

Returns the full path of the item.

Note:

The path is not canonicalised, so will not be in canonical form if the filename is a dots directory. For this you should use winstl::path, and call canonicalise()

size_t length

(

)

const

Returns the length of the full path.

operator char_type const *

(

)

const

Implicit conversion to a pointer-to-const of the full path.

Note:

The path is not canonicalised, so will not be in canonical form if the filename is a dots directory. For this you should use winstl::path, and call canonicalise()

Deprecated:

This is provided for backwards compatibility with an earlier version, but since this class does not have an implicit conversion constructor, it's pretty harmless.

bool is_directory

(

)

const

Indicates whether the entry is a directory.

bool is_file

(

)

const

Indicates whether the entry is a file.

bool is_compressed

(

)

const

Indicates whether the entry is compressed.

bool is_read_only

(

)

const

Indicates whether the entry is read-only.

bool is_system

(

)

const

Indicates whether the entry is a system file/directory.

bool is_hidden

(

)

const

Indicates whether the entry is hidden.

bool equal

(

char_type const *

rhs

)

const

Determines whether the instance is equal to the given path.

bool equal

(

class_type const &

rhs

)

const

Determines whether two instances are equal.

---

The documentation for this class was generated from the following file:

• winstl/filesystem/findfile_sequence.hpp