An opened file. More...

#include <uringpp/file.h>

Inheritance diagram for uringpp::file:

Collaboration diagram for uringpp::file:

[legend]

Public Member Functions
int	fd () const
	Get the file descriptor of the file. More...

	file (file &&other) noexcept
	Move construct a new file object. More...

	file (std::shared_ptr< event_loop > loop, int fd)
	Construct a new file object using the given event loop and file descriptor. The fd will be closed when the file object is destroyed. More...

task< void >	close ()
	Close the file. More...

	~file ()
	Destroy the file object. If the fd is still open, it will be closed. More...

sqe_awaitable	read (void *buf, size_t count, off_t offset=0)
	Read data from the file. More...

sqe_awaitable	write (void const *buf, size_t count, off_t offset=0)
	Write data to the file. More...

sqe_awaitable	readv (struct iovec const *iov, int iovcnt, off_t offset=0)
	Vectorized read from the file. More...

sqe_awaitable	writev (struct iovec const *iov, int iovcnt, off_t offset=0)
	Vectorized write to the file. More...

sqe_awaitable	read_fixed (void *buf, size_t count, off_t offset, int buf_index)
	Read data to a preregistered buffer from the file. More...

sqe_awaitable	write_fixed (void const *buf, size_t count, off_t offset, int buf_index)
	Write data from a preregistered buffer to the file. More...

sqe_awaitable	fsync (int flags)
	Asynchronously flush the file. More...

sqe_awaitable	sync_file_range (off_t offset, off_t nbytes, unsigned sync_range_flags)
	Asynchronously flush a range of the file. More...

sqe_awaitable	tee (file const &out, size_t count, unsigned int flags)
	Tee data from the file to another file. More...

sqe_awaitable	tee (socket const &out, size_t count, unsigned int flags)
	Tee data from the file to a socket. More...

sqe_awaitable	splice_to (loff_t off_in, size_t nbytes, pipe const &out, unsigned flags)
	Splice data from the file to a pipe. More...

sqe_awaitable	splice_from (pipe const &in, loff_t off_out, size_t nbytes, unsigned flags)
	Splice data from a pipe to the file. More...

Public Member Functions inherited from uringpp::noncopyable
	noncopyable (noncopyable &&)=default

	noncopyable (noncopyable const &)=delete

noncopyable &	operator= (noncopyable const &)=delete

noncopyable &	operator= (noncopyable &&)=default

Static Public Member Functions
static task< file >	open (std::shared_ptr< event_loop > loop, char const *path, int flags, mode_t mode)
	Opens a file in the current working directory. More...

static task< file >	openat (std::shared_ptr< event_loop > loop, dir const &dir, char const *path, int flags, mode_t mode)
	Open a file in the given directory. More...

static task< file >	openat2 (std::shared_ptr< event_loop > loop, dir const &dir, char const path, struct open_how how)
	Open a file in the given directory. More...

Protected Attributes
std::shared_ptr< event_loop >	loop_

int	fd_

Detailed Description

An opened file.

Constructor & Destructor Documentation

◆ file() [1/2]

uringpp::file::file ( file && other )

inlinenoexcept

Move construct a new file object.

Parameters

other The file object to move from.

◆ file() [2/2]

uringpp::file::file	(	std::shared_ptr< event_loop >	loop,
		int	fd
	)

inline

Construct a new file object using the given event loop and file descriptor. The fd will be closed when the file object is destroyed.

Parameters

loop	The event loop.
fd	The file descriptor.

◆ ~file()

uringpp::file::~file ( )

inline

Destroy the file object. If the fd is still open, it will be closed.

Member Function Documentation

◆ close()

task< void > uringpp::file::close ( )

inline

Close the file.

Returns: task<void>

◆ fd()

int uringpp::file::fd ( ) const

inline

Get the file descriptor of the file.

Returns: int The file descriptor of the file.

◆ fsync()

sqe_awaitable uringpp::file::fsync ( int flags )

inline

Asynchronously flush the file.

Parameters

flags The flags to use when flushing the file.

Returns: sqe_awaitable

◆ open()

static task< file > uringpp::file::open	(	std::shared_ptr< event_loop >	loop,
		char const *	path,
		int	flags,
		mode_t	mode
	)

inlinestatic

Opens a file in the current working directory.

Parameters

loop	The event loop.
path	The path to the file.
flags	The flags to use when opening the file.
mode	The mode to use when opening the file.

Returns: task<file> The file object.

Examples: helloworld.cc.

◆ openat()

static task< file > uringpp::file::openat	(	std::shared_ptr< event_loop >	loop,
		dir const &	dir,
		char const *	path,
		int	flags,
		mode_t	mode
	)

inlinestatic

Open a file in the given directory.

Parameters

loop	The event loop.
dir	The directory to open the file in.
path	The path to the file.
flags	The flags to use when opening the file.
mode	The mode to use when opening the file.

Returns: task<file> The file object.

◆ openat2()

static task< file > uringpp::file::openat2	(	std::shared_ptr< event_loop >	loop,
		dir const &	dir,
		char const *	path,
		struct open_how *	how
	)

inlinestatic

Open a file in the given directory.

Parameters

loop	The event loop.
dir	The directory to open the file in.
path	The path to the file.
how	The open_how struct to use when opening the file.

Returns: task<file>

◆ read()

sqe_awaitable uringpp::file::read	(	void *	buf,
		size_t	count,
		off_t	offset = `0`
	)

inline

Read data from the file.

Parameters

buf	The buffer to read into.
count	The number of bytes to read.
offset	The offset to start reading from.

Returns: sqe_awaitable

◆ read_fixed()

sqe_awaitable uringpp::file::read_fixed	(	void *	buf,
		size_t	count,
		off_t	offset,
		int	buf_index
	)

inline

Read data to a preregistered buffer from the file.

Parameters

buf	The preregistered buffer to read into.
count	The number of bytes to read.
offset	The offset to start reading from.
buf_index	The index of the preregistered buffer to read into.

Returns: sqe_awaitable

◆ readv()

sqe_awaitable uringpp::file::readv	(	struct iovec const *	iov,
		int	iovcnt,
		off_t	offset = `0`
	)

inline

Vectorized read from the file.

Parameters

iov	The iovec to read into.
iovcnt	The number of iovecs to read.
offset	The offset to start reading from.

Returns: sqe_awaitable

◆ splice_from()

sqe_awaitable uringpp::file::splice_from	(	pipe const &	in,
		loff_t	off_out,
		size_t	nbytes,
		unsigned	flags
	)

inline

Splice data from a pipe to the file.

Parameters

off_out	The offset to start splicing to.
in	The pipe to splice data from.
nbytes	The number of bytes to splice.
flags	The flags to use when splicing the data.

Returns: sqe_awaitable

◆ splice_to()

sqe_awaitable uringpp::file::splice_to	(	loff_t	off_in,
		size_t	nbytes,
		pipe const &	out,
		unsigned	flags
	)

inline

Splice data from the file to a pipe.

Parameters

off_in	The offset to start splicing from.
nbytes	The number of bytes to splice.
out	The pipe to splice data to.
flags	The flags to use when splicing the data.

Returns: sqe_awaitable

◆ sync_file_range()

sqe_awaitable uringpp::file::sync_file_range	(	off_t	offset,
		off_t	nbytes,
		unsigned	sync_range_flags
	)

inline

Asynchronously flush a range of the file.

Parameters

offset	The offset to start flushing from.
nbytes	The number of bytes to flush.
sync_range_flags	The flags to use when flushing the file.

Returns: sqe_awaitable

◆ tee() [1/2]

sqe_awaitable uringpp::file::tee	(	file const &	out,
		size_t	count,
		unsigned int	flags
	)

inline

Tee data from the file to another file.

Parameters

out	The file to tee data to.
count	The number of bytes to tee.
flags	The flags to use when teeing the data.

Returns: sqe_awaitable

◆ tee() [2/2]

sqe_awaitable uringpp::file::tee	(	socket const &	out,
		size_t	count,
		unsigned int	flags
	)

inline

Tee data from the file to a socket.

Parameters

out	The socket to tee data to.
count	The number of bytes to tee.
flags	The flags to use when teeing the data.

Returns: sqe_awaitable

◆ write()

sqe_awaitable uringpp::file::write	(	void const *	buf,
		size_t	count,
		off_t	offset = `0`
	)

inline

Write data to the file.

Parameters

buf	The buffer to write from.
count	The number of bytes to write.
offset	The offset to start writing from.

Returns: sqe_awaitable

◆ write_fixed()

sqe_awaitable uringpp::file::write_fixed	(	void const *	buf,
		size_t	count,
		off_t	offset,
		int	buf_index
	)

inline

Write data from a preregistered buffer to the file.

Parameters

buf	The preregistered buffer to write from.
count	The number of bytes to write.
offset	The offset to start writing from.
buf_index	The index of the preregistered buffer to write from.

Returns: sqe_awaitable

◆ writev()

sqe_awaitable uringpp::file::writev	(	struct iovec const *	iov,
		int	iovcnt,
		off_t	offset = `0`
	)

inline

Vectorized write to the file.

Parameters

iov	The iovec to write from.
iovcnt	The number of iovecs to write.
offset	The offset to start writing from.

Returns: sqe_awaitable

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

include/uringpp/file.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ file() [1/2]

◆ file() [2/2]

◆ ~file()

Member Function Documentation

◆ close()

◆ fd()

◆ fsync()

◆ open()

◆ openat()

◆ openat2()

◆ read()

◆ read_fixed()

◆ readv()

◆ splice_from()

◆ splice_to()

◆ sync_file_range()

◆ tee() [1/2]

◆ tee() [2/2]

◆ write()

◆ write_fixed()

◆ writev()