Change a file mode bits. More...

#include "request-fs.hpp"

Inheritance diagram for uv::fs::chmod:

Public Types
using	on_request_t = std::function< void(chmod _request) >
	The function type of the callback called when the `chmod` request has completed.

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
	chmod (const chmod &)=default

chmod &	operator= (const chmod &)=default

	chmod (chmod &&) noexcept=default

chmod &	operator= (chmod &&) noexcept=default

on_request_t &	on_request () const noexcept

file	handle () const noexcept
	The file which this chmod request has been running on. More...

const char *	path () const noexcept
	The file path affected by request. More...

int	run (uv::loop &_loop, const char *_path, int _mode)
	Run the request. Change permissions of a file or directory specified by `_path`. More...

int	run (file &_file, int _mode)
	Run the request. Change permissions of the open `_file`. 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

Change a file mode bits.

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

Member Function Documentation

◆ handle()

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

inlinenoexcept

The file which this chmod request has been running on.

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

If the request was applied to a file path then the handle of the returned file is closed (i.e. uv::file::is_closing() == 1).

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

◆ path()

const char* uv::fs::chmod::path ( ) const

inlinenoexcept

The file path affected by request.

See also: libuv API documentation: uv_fs_t.path.

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

◆ run() [1/2]

int uv::fs::chmod::run	(	uv::loop &	_loop,
		const char *	_path,
		int	_mode
	)

inline

Run the request. Change permissions of a file or directory specified by _path.

See also: libuv API documentation: uv_fs_chmod().; Linux: chmod(),
Windows: _chmod().

Note: If the request callback is empty (has not been set), the request runs synchronously.

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

◆ run() [2/2]

int uv::fs::chmod::run	(	file &	_file,
		int	_mode
	)

inline

Run the request. Change permissions of the open _file.

See also: libuv API documentation: uv_fs_fchmod().; Linux: fchmod().

Note: If the request callback is empty (has not been set), the request runs synchronously.

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

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

request-fs.hpp