uvcc
libuv C++ bindings
uv::fs::access Class Reference

Check user's permissions for a file. More...

#include "request-fs.hpp"

Inheritance diagram for uv::fs::access:
uv::fs uv::request

Public Types

using on_request_t = std::function< void(access _request) >
 The function type of the callback called when the access 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

 access (const access &)=default
 
accessoperator= (const access &)=default
 
 access (access &&) noexcept=default
 
accessoperator= (access &&) noexcept=default
 
on_request_ton_request () const noexcept
 
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. Check if the calling process can access the file specified by _path using the access _mode. More...
 
 operator const uv_t * () const noexcept
 
 operator uv_t * () noexcept
 
- Public Member Functions inherited from uv::fs
 fs (const fs &)=default
 
fsoperator= (const fs &)=default
 
 fs (fs &&) noexcept=default
 
fsoperator= (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)
 
requestoperator= (const request &_that)
 
 request (request &&_that) noexcept
 
requestoperator= (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_ton_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

Check user's permissions for a file.

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

Member Function Documentation

◆ path()

const char* uv::fs::access::path ( ) const
inlinenoexcept

The file path affected by request.

See also
libuv API documentation: uv_fs_t.path.

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

◆ run()

int uv::fs::access::run ( uv::loop _loop,
const char *  _path,
int  _mode 
)
inline

Run the request. Check if the calling process can access the file specified by _path using the access _mode.

See also
libuv API documentation: uv_fs_access().
Linux: access().
Note
If the request callback is empty (has not been set), the request runs synchronously.

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


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