uv::fs::read Class Reference

Read data from a file. More...

#include "request-fs.hpp"

Inheritance diagram for uv::fs::read:

Public Types
using	on_request_t = std::function< void(read _request, buffer _buffer) >
	The function type of the callback called when data was read from the file.
Public Types inherited from uv::fs
using	uv_t = ::uv_fs_t
Public Types inherited from uv::request
using	uv_t = ::uv_req_t
using	on_destroy_t = std::function< void(void *_data) >
	The function type of the callback called when the request object is about to be destroyed.

Public Member Functions
	read (const read &)=default
read &	operator= (const read &)=default
	read (read &&) noexcept=default
read &	operator= (read &&) noexcept=default
on_request_t &	on_request () const noexcept
file	handle () const noexcept
	The file which this read request has been running on. More...
int64_t	offset () const noexcept
	The offset this read request has been performed at.
int	run (file &_file, buffer &_buf, int64_t _offset)
	Run the request. Read data from the _file into the buffers described by _buf object. More...
	operator const uv_t * () const noexcept
	operator uv_t * () noexcept
Public Member Functions inherited from uv::fs
	fs (const fs &)=default
fs &	operator= (const fs &)=default
	fs (fs &&) noexcept=default
fs &	operator= (fs &&) noexcept=default
::uv_fs_type	fs_type () const noexcept
	The tag indicating a subtype of the filesystem request. More...
uv::loop	loop () const noexcept
	The libuv loop that started this filesystem request and where completion will be reported.
	operator const uv_t * () const noexcept
	operator uv_t * () noexcept
Public Member Functions inherited from uv::request
	request (const request &_that)
request &	operator= (const request &_that)
	request (request &&_that) noexcept
request &	operator= (request &&_that) noexcept
void	swap (request &_that) noexcept
std::uintptr_t	id () const noexcept
long	nrefs () const noexcept
	The current number of existing references to the same object as this request variable refers to.
int	uv_status () const noexcept
	The status value returned by the last executed libuv API function on this request.
on_destroy_t &	on_destroy () const noexcept
::uv_req_type	type () const noexcept
	The tag indicating a libuv type of the request. More...
const char *	type_name () const noexcept
	A string containing the name of the request type.
void *const &	data () const noexcept
	The pointer to the user-defined arbitrary data. libuv and uvcc does not use this field.
void *&	data () noexcept
int	cancel () noexcept
	Cancel a pending request. More...
	operator const uv_t * () const noexcept
	operator uv_t * () noexcept
	operator bool () const noexcept
	Equivalent to (uv_status() >= 0).

Detailed Description

Read data from a file.

Definition at line 261 of file request-fs.hpp.

Member Function Documentation

handle()

file uv::fs::read::handle ( ) const

inlinenoexcept

The file which this read request has been running on.

It is guaranteed that it will be a valid instance at least within the request callback.

Definition at line 314 of file request-fs.hpp.

run()

int uv::fs::read::run ( file &  _file, buffer &  _buf, int64_t  _offset  )

inline

Run the request. Read data from the _file into the buffers described by _buf object.

See also

libuv API documentation: uv_fs_read().

Linux: preadv().

Note

If the request callback is empty (has not been set), the request runs synchronously. In this case the function returns a number of bytes read or relevant libuv error code.

The _offset value of < 0 means using of the current file position.

See also

Windows: _tell(), _telli64().

Definition at line 326 of file request-fs.hpp.

---

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

• request-fs.hpp