Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r62909 - trunk/libs/iostreams/doc/classes
From: steven_at_[hidden]
Date: 2010-06-13 11:09:17

Author: steven_watanabe
Date: 2010-06-13 11:09:16 EDT (Sun, 13 Jun 2010)
New Revision: 62909
URL: http://svn.boost.org/trac/boost/changeset/62909

Log:
Document missing members of file_descriptor*. Fixes #3955.
Text files modified:
trunk/libs/iostreams/doc/classes/file_descriptor.html | 171 +++++++++++++++++++++++++++++++++++----
1 files changed, 150 insertions(+), 21 deletions(-)

Modified: trunk/libs/iostreams/doc/classes/file_descriptor.html
==============================================================================
--- trunk/libs/iostreams/doc/classes/file_descriptor.html (original)
+++ trunk/libs/iostreams/doc/classes/file_descriptor.html 2010-06-13 11:09:16 EDT (Sun, 13 Jun 2010)
@@ -91,7 +91,7 @@

<H4>Description</H4>

-Model of Source providing read-only access to a file through an operating system file descriptor.
+Model of SeekableSource and Closable providing read-only access to a file through an operating system file descriptor.

<H4>Synopsis</H4>

@@ -100,8 +100,11 @@
class file_descriptor_source {
public:
 typedef char char_type;
+ typedef [implementation-defined] handle_type;
 typedef [implementation-defined] category;
- <A CLASS="documented" HREF="#file_descriptor_source_ctor">file_descriptor_source</A>( const std::string& pathname,
+ <A CLASS="documented" HREF="#file_descriptor_source_ctor">file_descriptor_source</A>();
+ template<typename Path>
+ <A CLASS="documented" HREF="#file_descriptor_source_ctor">file_descriptor_source</A>( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::in );
 <A CLASS="documented" HREF="#file_descriptor_source_ctor">file_descriptor_source</A>( int fd, bool close_on_exit = false );
@@ -109,7 +112,18 @@
 // Windows-only
 <A CLASS="documented" HREF="#file_descriptor_source_ctor">file_descriptor_source</A>( HANDLE hFile, bool close_on_exit = false );

+ template<typename Path>
+ void <A CLASS="documented" HREF="#file_descriptor_source_open">open</A>( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::in );
+ void <A CLASS="documented" HREF="#file_descriptor_source_open">open</A>( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void <A CLASS="documented" HREF="#file_descriptor_source_open">open</A>( HANDLE hFile, bool close_on_exit = false );
+
 bool <A CLASS="documented" HREF="#file_descriptor_source_is_open">is_open</A>() const;
+
+ handle_type <A CLASS="documented" HREF="#file_descriptor_source_handle">handle</A>() const;
};

} } // End namespace boost::io</PRE>
@@ -117,24 +131,46 @@
<A NAME="file_descriptor_source_ctor"></A>
<H4><CODE>file_descriptor_source::file_descriptor_source</CODE></H4>

-<PRE CLASS="broken_ie"> file_descriptor_source( const std::string& pathname,
+<PRE CLASS="broken_ie"> file_descriptor_source();
+ template<typename Path>
+ file_descriptor_source( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::in );
 file_descriptor_source( int fd, bool close_on_exit = false );

 // Windows-only
 file_descriptor_source( HANDLE hFile, bool close_on_exit = false );</PRE>
-
+
+
+ The first member constructs an empty <CODE>file_descriptor_source</CODE>.
+
+
+
+ The second member constructs a <CODE>file_descriptor_source</CODE> to access the file with the given pathname. <CODE>Path</CODE> should be either a string or a Boost.Filesystem path. The parameter <CODE>mode</CODE> has the same interpretation as <CODE>(mode | std::ios_base::in)</CODE> in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref" HREF="#note_1">[1]</A>
+
+

- The first member constructs a <CODE>file_descriptor_source</CODE> to access the file with the given pathname. The parameter <CODE>mode</CODE> has the same interpretation as <CODE>(mode | std::ios_base::in)</CODE> in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref" HREF="#note_1">[1]</A>
+ The third member constructs a <CODE>file_descriptor_source</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the <CODE>file_descriptor_source</CODE> being constructed — or one of its copies — is closed.



- The second member constructs a <CODE>file_descriptor_source</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the <CODE>file_descriptor_source</CODE> being constructed — or one of its copies — is closed.
+ The fourth member is the same as the third, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the <CODE>file_descriptor_source</CODE> being constructed — or one of its copies — is closed.


+<A NAME="file_descriptor_source_open"></A>
+<H4><CODE>file_descriptor_source::open</CODE></H4>
+
+<PRE CLASS="broken_ie"> template<typename Path>
+ void open( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::in );
+ void open( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void open( HANDLE hFile, bool close_on_exit = false );</PRE>
+

- The third member is the same as the second, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the <CODE>file_descriptor_source</CODE> being constructed — or one of its copies — is closed.
+ The parameters of <CODE>open</CODE> the same as those of the corresponding constructors.


<A NAME="file_descriptor_source_is_open"></A>
@@ -144,12 +180,19 @@

Returns <CODE>true</CODE> if the underlying file was opened successfully.

+<A NAME="file_descriptor_source_handle"></A>
+<H4><CODE>file_descriptor_source::handle</CODE></H4>
+
+<PRE CLASS="broken_ie"> handle_type handle() const;</PRE>
+
+Returns the underlying OS file descriptor. On Windows, this is a <CODE>HANDLE</CODE>. On other systems, it is an <CODE>int</CODE>.
+
<A NAME="file_descriptor_sink"></A>
<H3>Class <CODE>file_descriptor_sink</CODE></H3>

<H4>Description</H4>

-Model of Sink providing write-only access to a file through an operating system file descriptor.
+Model of SeekableSink and Closable providing write-only access to a file through an operating system file descriptor.

<H4>Synopsis</H4>

@@ -158,8 +201,11 @@
class file_descriptor_sink {
public:
 typedef char char_type;
+ typedef [implementation-defined] handle_type;
 typedef [implementation-defined] category;
- <A CLASS="documented" HREF="#file_descriptor_sink_ctor">file_descriptor_sink</A>( const std::string& pathname,
+ <A CLASS="documented" HREF="#file_descriptor_sink_ctor">file_descriptor_sink</A>();
+ template<typename Path>
+ <A CLASS="documented" HREF="#file_descriptor_sink_ctor">file_descriptor_sink</A>( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::out );
 <A CLASS="documented" HREF="#file_descriptor_sink_ctor">file_descriptor_sink</A>( int fd, bool close_on_exit = false );
@@ -167,7 +213,18 @@
 // Windows-only
 <A CLASS="documented" HREF="#file_descriptor_sink_ctor">file_descriptor_sink</A>( HANDLE hFile, bool close_on_exit = false );

+ template<typename Path>
+ void <A CLASS="documented" HREF="#file_descriptor_sink_open">open</A>( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::out );
+ void <A CLASS="documented" HREF="#file_descriptor_sink_open">open</A>( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void <A CLASS="documented" HREF="#file_descriptor_sink_open">open</A>( HANDLE hFile, bool close_on_exit = false );
+
 bool <A CLASS="documented" HREF="#file_descriptor_sink_is_open">is_open</A>() const;
+
+ handle_type <A CLASS="documented" HREF="#file_descriptor_sink_handle">handle</A>() const;
};

} } // End namespace boost::io</PRE>
@@ -175,24 +232,46 @@
<A NAME="file_descriptor_sink_ctor"></A>
<H4><CODE>file_descriptor_sink::file_descriptor_sink</CODE></H4>

-<PRE CLASS="broken_ie"> file_descriptor_sink( const std::string& pathname,
+<PRE CLASS="broken_ie"> file_descriptor_sink();
+ template<typename Path>
+ file_descriptor_sink( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::out );
 file_descriptor_sink( int fd, bool close_on_exit = false );

 // Windows-only
 file_descriptor_sink( HANDLE hFile, bool close_on_exit = false );</PRE>
-
+
+
+ The first member constructs an empty <CODE>file_descriptor_sink</CODE>.
+
+
+
+ The second member constructs a <CODE>file_descriptor_sink</CODE> to access the file with the given pathname. <CODE>Path</CODE> should be either a string or a Boost.Filesystem path. The parameter <CODE>mode</CODE> has the same interpretation as <CODE>(mode | std::ios_base::out)</CODE> in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref2" HREF="#note_1">[1]</A>
+
+

- The first member constructs a <CODE>file_descriptor_sink</CODE> to access the file with the given pathname. The parameter <CODE>mode</CODE> has the same interpretation as <CODE>(mode | std::ios_base::out)</CODE> in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref2" HREF="#note_1">[1]</A>
+ The third member constructs a <CODE>file_descriptor_sink</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor_sink</CODE> — or one of its copies — is closed.



- The second member constructs a <CODE>file_descriptor_sink</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor_sink</CODE> — or one of its copies — is closed.
+ The fourth member is the same as the third, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor_sink</CODE> — or one of its copies — is closed.


+<A NAME="file_descriptor_sink_open"></A>
+<H4><CODE>file_descriptor_sink::open</CODE></H4>
+
+<PRE CLASS="broken_ie"> template<typename Path>
+ void open( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::out );
+ void open( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void open( HANDLE hFile, bool close_on_exit = false );</PRE>
+

- The third member is the same as the second, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor_sink</CODE> — or one of its copies — is closed.
+ The parameters of <CODE>open</CODE> the same as those of the corresponding constructors.


<A NAME="file_descriptor_sink_is_open"></A>
@@ -202,12 +281,19 @@

Returns <CODE>true</CODE> if the underlying file was opened successfully.

+<A NAME="file_descriptor_sink_handle"></A>
+<H4><CODE>file_descriptor_sink::handle</CODE></H4>
+
+<PRE CLASS="broken_ie"> handle_type handle() const;</PRE>
+
+Returns the underlying OS file descriptor. On Windows, this is a <CODE>HANDLE</CODE>. On other systems, it is an <CODE>int</CODE>.
+
<A NAME="file_descriptor"></A>
<H3>Class <CODE>file_descriptor</CODE></H3>

<H4>Description</H4>

-Model of SeekableDevice providing read-write access to a file through an operating system file descriptor.
+Model of SeekableDevice and Closable providing read-write access to a file through an operating system file descriptor.

<H4>Synopsis</H4>

@@ -216,8 +302,11 @@
class file_descriptor {
public:
 typedef char char_type;
+ typedef [implementation-defined] handle_type;
 typedef [implementation-defined] category;
- <A CLASS="documented" HREF="#file_descriptor_constructor">file_descriptor</A>( const std::string& pathname,
+ <A CLASS="documented" HREF="#file_descriptor_constructor">file_descriptor</A>();
+ template<typename Path>
+ <A CLASS="documented" HREF="#file_descriptor_constructor">file_descriptor</A>( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::in | std::ios_base::out );
 <A CLASS="documented" HREF="#file_descriptor_constructor">file_descriptor</A>( int fd, bool close_on_exit = false );
@@ -225,7 +314,18 @@
 // Windows-only
 <A CLASS="documented" HREF="#file_descriptor_constructor">file_descriptor</A>( HANDLE hFile, bool close_on_exit = false );

+ template<typename Path>
+ void <A CLASS="documented" HREF="#file_descriptor_open">open</A>( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::in | std::ios_base::out );
+ void <A CLASS="documented" HREF="#file_descriptor_open">open</A>( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void <A CLASS="documented" HREF="#file_descriptor_open">open</A>( HANDLE hFile, bool close_on_exit = false );
+
 bool <A CLASS="documented" HREF="#file_descriptor_is_open">is_open</A>() const;
+
+ handle_type <A CLASS="documented" HREF="#file_descriptor_handle">handle</A>() const;
};

} } // End namespace boost::io</PRE>
@@ -233,7 +333,9 @@
<A NAME="file_descriptor_constructor"></A>
<H4><CODE>file_descriptor::file_descriptor</CODE></H4>

-<PRE CLASS="broken_ie"> file_descriptor( const std::string& pathname,
+<PRE CLASS="broken_ie"> file_descriptor();
+ template<typename Path>
+ file_descriptor( const Path& pathname,
 std::ios_base::open_mode mode =
 std::ios_base::in | std::ios_base::out );
 file_descriptor( int fd, bool close_on_exit = false );
@@ -242,15 +344,35 @@
 file_descriptor( HANDLE hFile, bool close_on_exit = false );</PRE>


- The first member constructs a <CODE>file_descriptor</CODE> to access the file with the given pathname. The parameter <CODE>mode</CODE> has the same interpretation as in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref3" HREF="#note_1">[1]</A>
+ The first member constructs an empty <CODE>file_descriptor</CODE>.



- The second member constructs a <CODE>file_descriptor</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor</CODE> — or one of its copies — is closed.
+ The second member constructs a <CODE>file_descriptor</CODE> to access the file with the given pathname. <CODE>Path</CODE> should be either a string or a Boost.Filesystem path. The parameter <CODE>mode</CODE> has the same interpretation as in <CODE>std::basic_filebuf::open</CODE>.<A CLASS="footnote_ref" NAME="note_1_ref3" HREF="#note_1">[1]</A>



- The third member is the same as the second, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor</CODE> — or one of its copies — is closed.
+ The third member constructs a <CODE>file_descriptor</CODE> to access the file with the given operating system or runtime-library file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor</CODE> — or one of its copies — is closed.
+
+
+
+ The fourth member is the same as the third, except that it accepts a Windows file handle instead of a file descriptor. If the second argument is <CODE>true</CODE>, the file descriptor is closed when the new <CODE>file_descriptor</CODE> — or one of its copies — is closed.
+
+
+<A NAME="file_descriptor_open"></A>
+<H4><CODE>file_descriptor::open</CODE></H4>
+
+<PRE CLASS="broken_ie"> template<typename Path>
+ void open( const Path& pathname,
+ std::ios_base::open_mode mode =
+ std::ios_base::in | std::ios_base::out );
+ void open( int fd, bool close_on_exit = false );
+
+ // Windows-only
+ void open( HANDLE hFile, bool close_on_exit = false );</PRE>
+
+
+ The parameters of <CODE>open</CODE> the same as those of the corresponding constructors.


<A NAME="file_descriptor_is_open"></A>
@@ -258,7 +380,14 @@

<PRE CLASS="broken_ie"> bool is_open() const;</PRE>

-Returns <CODE>true</CODE> if the underlying file was opened successfully.
+Returns <CODE>true</CODE> if the underlying file was opened successfully.
+
+<A NAME="file_descriptor_handle"></A>
+<H4><CODE>file_descriptor::handle</CODE></H4>
+
+<PRE CLASS="broken_ie"> handle_type handle() const;</PRE>
+
+Returns the underlying OS file descriptor. On Windows, this is a <CODE>HANDLE</CODE>. On other systems, it is an <CODE>int</CODE>.

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk