summaryrefslogtreecommitdiff
path: root/include/nsutils/unistd.h
blob: be11382b46ae0c335d6383461d5a8efc91f5c022 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/*
 * Copyright 2015 Vincent Sanders <vince@netsurf-browser.org>
 *
 * This file is part of libnsutils.
 *
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 */

/**
 * \file
 * Time related operations.
 */

#ifndef NSUTILS_UNISTD_H_
#define NSUTILS_UNISTD_H_

/**
 * Perform a write operation at a specific offset
 *
 * This writes the data into the file specifid by teh file handle at teh given
 * offset. The offset may be beyond the existing file extent.
 *
 * This provides a uniform interface to the pwrite operation without system
 * specific implementation details.
 *
 * \note The write pointer on the fd may be moved by this operation which
 * differs from the posix version.
 *
 * \param fd The file descriptor.
 * \param buf The data to write.
 * \param count The length of data in \a buf to write.
 * \param offset The offset into the file to write the data.
 * \return the number of bytes written or -1 on error and errno set.
 */
ssize_t nsu_pwrite(int fd, const void *buf, size_t count, off_t offset);

/**
 * Perform a read from a specific offset.
 *
 * This provides a uniform interface to the POSIX pread operation without
 * system specific implementation details.
 *
 * \note The read pointer on the fd may be moved by this operation which
 * differs from the POSIX version.
 *
 * \param fd The file descriptor.
 * \param buf The buffer to place the data into.
 * \param count The length of data to read.
 * \param offset The offset into the file to read the data from.
 * \return the number of bytes read or -1 on error and errno set.
 */
ssize_t nsu_pread(int fd, void *buf, size_t count, off_t offset);

#endif