boost::afio::path_req Struct Reference

A convenience bundle of path and flags, with optional precondition. Paths may be a path fragment (relative to the precondition) or absolute, in which case if necessary they are made canonical and absolute in the constructor according to the current working directory. More...

Inheritance diagram for boost::afio::path_req:

List of all members.

Classes
struct	absolute
	Convenience tag type constructing an absolute path path_req. More...
struct	relative
	Convenience tag type constructing a relative path path_req. More...
Public Member Functions
	path_req ()
	Default constructor.
	path_req (const path_req &o)
	Copy constructor.
	path_req (path_req &&o) noexcept
	Move constructor.
	path_req (absolute &&o)
	Move constructor.
	path_req (relative &&o)
	Move constructor.
template<class T , typename = typename std::enable_if<!std::is_constructible<path_req, T>::value && !std::is_constructible<future<>, T>::value>::type>
	path_req (T &&_path, file_flags _flags=file_flags::none)
	Constructs an instance.
template<class T , typename = typename std::enable_if<!std::is_convertible<boost::afio::path, T>::value>::type>
	path_req (bool _is_relative, future<> _precondition, T &&_path, file_flags _flags=file_flags::none)
	Constructs an instance.
	path_req (bool _is_relative, future<> _precondition, boost::afio::path _path, file_flags _flags=file_flags::none)
	path_req (future<> _precondition, file_flags _flags=file_flags::none)
	Constructs an instance.
bool	validate () const
	Validates contents.
Public Attributes
bool	is_relative
	Whether the precondition is also where this path begins.
boost::afio::path	path
	The filing system path to be used for this operation.
file_flags	flags
	The flags to be used for this operation (note they can be overriden by flags passed during dispatcher construction).
future	precondition
Protected Member Functions
void	_validate () const

---

Detailed Description

A convenience bundle of path and flags, with optional precondition. Paths may be a path fragment (relative to the precondition) or absolute, in which case if necessary they are made canonical and absolute in the constructor according to the current working directory.

Definition at line 2737 of file afio.hpp.

---

Constructor & Destructor Documentation

boost::afio::path_req::path_req

(

)

Default constructor.

Definition at line 2748 of file afio.hpp.

boost::afio::path_req::path_req

(

const path_req &

o

)

Copy constructor.

boost::afio::path_req::path_req

(

path_req &&

o

)

Move constructor.

Definition at line 2752 of file afio.hpp.

boost::afio::path_req::path_req

(

path_req::absolute &&

o

)

Move constructor.

Definition at line 2827 of file afio.hpp.

boost::afio::path_req::path_req

(

path_req::relative &&

o

)

Move constructor.

Definition at line 2828 of file afio.hpp.

template<class T , typename = typename std::enable_if<!std::is_constructible<path_req, T>::value && !std::is_constructible<future<>, T>::value>::type>

boost::afio::path_req::path_req	(	T &&	_path,
		file_flags	_flags = file_flags::none
	)

Constructs an instance.

Template Parameters:

class T

The type of path to be used.

Parameters:

_path	The filing system path to be used.
_flags	The flags to be used.

Definition at line 2764 of file afio.hpp.

template<class T , typename = typename std::enable_if<!std::is_convertible<boost::afio::path, T>::value>::type>

boost::afio::path_req::path_req	(	bool	_is_relative,
		future<>	_precondition,
		T &&	_path,
		file_flags	_flags = file_flags::none
	)

Constructs an instance.

Template Parameters:

class T

The type of path to be used.

Parameters:

_is_relative	Whether the precondition is where the path begins
_precondition	The precondition for this operation.
_path	The filing system path to be used.
_flags	The flags to be used.

Definition at line 2773 of file afio.hpp.

boost::afio::path_req::path_req	(	bool	_is_relative,
		future<>	_precondition,
		boost::afio::path	_path,
		file_flags	_flags = file_flags::none
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2775 of file afio.hpp.

boost::afio::path_req::path_req	(	future<>	_precondition,
		file_flags	_flags = file_flags::none
	)

Constructs an instance.

Parameters:

_precondition	The precondition for this operation (used as the path).
_flags	The flags to be used.

Definition at line 2781 of file afio.hpp.

---

Member Function Documentation

bool boost::afio::path_req::validate

(

)

const

Validates contents.

Definition at line 2783 of file afio.hpp.

---

Member Data Documentation

bool boost::afio::path_req::is_relative

Whether the precondition is also where this path begins.

Definition at line 2739 of file afio.hpp.

boost::afio::path boost::afio::path_req::path

The filing system path to be used for this operation.

Definition at line 2740 of file afio.hpp.

file_flags boost::afio::path_req::flags

The flags to be used for this operation (note they can be overriden by flags passed during dispatcher construction).

Definition at line 2741 of file afio.hpp.

future boost::afio::path_req::precondition

An optional precondition for this operation

Definition at line 2742 of file afio.hpp.