Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::iostreams::mapped_file Class Reference

#include <mapped_file.hpp>

Inheritance diagram for boost::iostreams::mapped_file:
Collaboration diagram for boost::iostreams::mapped_file:

Classes

struct  category
 

Public Types

typedef char char_type
 
typedef
mapped_file_source::size_type 
size_type
 
typedef char * iterator
 
typedef const char * const_iterator
 
enum  mapmode {
  readonly = 1,
  readwrite = 2,
  priv = 4
}
 

Public Member Functions

 BOOST_STATIC_CONSTANT (size_type, max_length=delegate_type::max_length)
 
 mapped_file ()
 
template<typename Path >
 mapped_file (const basic_mapped_file_params< Path > &p)
 
template<typename Path >
 mapped_file (const Path &path, mapmode flags, size_type length=max_length, stream_offset offset=0)
 
template<typename Path >
 mapped_file (const Path &path, BOOST_IOS::openmode mode=BOOST_IOS::in|BOOST_IOS::out, size_type length=max_length, stream_offset offset=0)
 
 mapped_file (const mapped_file &other)
 
 operator mapped_file_source & ()
 
 operator const mapped_file_source & () const
 
template<typename Path >
void open (const basic_mapped_file_params< Path > &p)
 
template<typename Path >
void open (const Path &path, mapmode mode, size_type length=max_length, stream_offset offset=0)
 
template<typename Path >
void open (const Path &path, BOOST_IOS::openmode mode=BOOST_IOS::in|BOOST_IOS::out, size_type length=max_length, stream_offset offset=0)
 
bool is_open () const
 
void close ()
 
 operator safe_bool () const
 
bool operator! () const
 
mapmode flags () const
 
size_type size () const
 
char * data () const
 
const char * const_data () const
 
iterator begin () const
 
const_iterator const_begin () const
 
iterator end () const
 
const_iterator const_end () const
 
void resize (stream_offset new_size)
 

Static Public Member Functions

static int alignment ()
 

Friends

struct boost::iostreams::operations< mapped_file >
 
class mapped_file_sink
 

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
readonly 
readwrite 
priv 

Constructor & Destructor Documentation

boost::iostreams::mapped_file::mapped_file ( )
inline
template<typename Path >
boost::iostreams::mapped_file::mapped_file ( const basic_mapped_file_params< Path > &  p)
explicit

References open().

template<typename Path >
boost::iostreams::mapped_file::mapped_file ( const Path &  path,
mapmode  flags,
size_type  length = max_length,
stream_offset  offset = 0 
)

References open().

template<typename Path >
boost::iostreams::mapped_file::mapped_file ( const Path &  path,
BOOST_IOS::openmode  mode = BOOST_IOS::in | BOOST_IOS::out,
size_type  length = max_length,
stream_offset  offset = 0 
)
explicit

References open().

boost::iostreams::mapped_file::mapped_file ( const mapped_file other)

Member Function Documentation

static int boost::iostreams::mapped_file::alignment ( )
inlinestatic
boost::iostreams::mapped_file::BOOST_STATIC_CONSTANT ( size_type  ,
max_length  = delegate_type::max_length 
)
void boost::iostreams::mapped_file::close ( )
inline
const_iterator boost::iostreams::mapped_file::const_begin ( ) const
inline
const char* boost::iostreams::mapped_file::const_data ( ) const
inline
const_iterator boost::iostreams::mapped_file::const_end ( ) const
inline

References boost::size().

char * boost::iostreams::mapped_file::data ( ) const
inline
mapmode boost::iostreams::mapped_file::flags ( ) const
inline
bool boost::iostreams::mapped_file::is_open ( ) const
inline
template<typename Path >
void boost::iostreams::mapped_file::open ( const basic_mapped_file_params< Path > &  p)
template<typename Path >
void boost::iostreams::mapped_file::open ( const Path &  path,
BOOST_IOS::openmode  mode = BOOST_IOS::in | BOOST_IOS::out,
size_type  length = max_length,
stream_offset  offset = 0 
)
boost::iostreams::mapped_file::operator const mapped_file_source & ( ) const
inline
boost::iostreams::mapped_file::operator mapped_file_source & ( )
inline
boost::iostreams::mapped_file::operator safe_bool ( ) const
inline
bool boost::iostreams::mapped_file::operator! ( ) const
inline
void boost::iostreams::mapped_file::resize ( stream_offset  new_size)
size_type boost::iostreams::mapped_file::size ( void  ) const
inline

Friends And Related Function Documentation

friend struct boost::iostreams::operations< mapped_file >
friend
friend class mapped_file_sink
friend

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