OLD | NEW |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef SERVICES_FILES_UTIL_H_ | 5 #ifndef SERVICES_FILES_UTIL_H_ |
6 #define SERVICES_FILES_UTIL_H_ | 6 #define SERVICES_FILES_UTIL_H_ |
7 | 7 |
8 #include "mojo/services/files/public/interfaces/types.mojom.h" | 8 #include "mojo/services/files/public/interfaces/types.mojom.h" |
9 | 9 |
10 namespace mojo { | 10 namespace mojo { |
11 | 11 |
12 class String; | 12 class String; |
13 | 13 |
14 namespace files { | 14 namespace files { |
15 | 15 |
16 // Validation functions (typically used to check arguments; they return | 16 // Validation functions (typically used to check arguments; they return |
17 // |ERROR_OK| if valid, else the standard/recommended error for the validation | 17 // |Error::OK| if valid, else the standard/recommended error for the validation |
18 // error): | 18 // error): |
19 | 19 |
20 // Checks if |path|, which must be non-null, is (looks like) a valid (relative) | 20 // Checks if |path|, which must be non-null, is (looks like) a valid (relative) |
21 // path. (On failure, returns |ERROR_INVALID_ARGUMENT| if |path| is not UTF-8, | 21 // path. (On failure, returns |Error::INVALID_ARGUMENT| if |path| is not UTF-8, |
22 // or |ERROR_PERMISSION_DENIED| if it is not relative.) | 22 // or |Error::PERMISSION_DENIED| if it is not relative.) |
23 Error IsPathValid(const String& path); | 23 Error IsPathValid(const String& path); |
24 | 24 |
25 // Checks if |whence| is a valid (known) |Whence| value. (On failure, returns | 25 // Checks if |whence| is a valid (known) |Whence| value. (On failure, returns |
26 // |ERROR_UNIMPLEMENTED|.) | 26 // |Error::UNIMPLEMENTED|.) |
27 Error IsWhenceValid(Whence whence); | 27 Error IsWhenceValid(Whence whence); |
28 | 28 |
29 // Checks if |offset| is a valid file offset (from some point); this is | 29 // Checks if |offset| is a valid file offset (from some point); this is |
30 // implementation-dependent (typically checking if |offset| fits in an |off_t|). | 30 // implementation-dependent (typically checking if |offset| fits in an |off_t|). |
31 // (On failure, returns |ERROR_OUT_OF_RANGE|.) | 31 // (On failure, returns |Error::OUT_OF_RANGE|.) |
32 Error IsOffsetValid(int64_t offset); | 32 Error IsOffsetValid(int64_t offset); |
33 | 33 |
34 // Conversion functions: | 34 // Conversion functions: |
35 | 35 |
36 // Converts a standard errno value (|E...|) to an |Error| value. | 36 // Converts a standard errno value (|E...|) to an |Error| value. |
37 Error ErrnoToError(int errno_value); | 37 Error ErrnoToError(int errno_value); |
38 | 38 |
39 // Converts a |Whence| value to a standard whence value (|SEEK_...|). | 39 // Converts a |Whence| value to a standard whence value (|SEEK_...|). |
40 int WhenceToStandardWhence(Whence whence); | 40 int WhenceToStandardWhence(Whence whence); |
41 | 41 |
42 // Converts a |Timespec| to a |struct timespec|. If |in| is null, |out->tv_nsec| | 42 // Converts a |Timespec| to a |struct timespec|. If |in| is null, |out->tv_nsec| |
43 // is set to |UTIME_OMIT|. | 43 // is set to |UTIME_OMIT|. |
44 Error TimespecToStandardTimespec(const Timespec* in, struct timespec* out); | 44 Error TimespecToStandardTimespec(const Timespec* in, struct timespec* out); |
45 | 45 |
46 // Converts a |TimespecOrNow| to a |struct timespec|. If |in| is null, | 46 // Converts a |TimespecOrNow| to a |struct timespec|. If |in| is null, |
47 // |out->tv_nsec| is set to |UTIME_OMIT|; if |in->now| is set, |out->tv_nsec| is | 47 // |out->tv_nsec| is set to |UTIME_OMIT|; if |in->now| is set, |out->tv_nsec| is |
48 // set to |UTIME_NOW|. | 48 // set to |UTIME_NOW|. |
49 Error TimespecOrNowToStandardTimespec(const TimespecOrNow* in, | 49 Error TimespecOrNowToStandardTimespec(const TimespecOrNow* in, |
50 struct timespec* out); | 50 struct timespec* out); |
51 | 51 |
52 } // namespace files | 52 } // namespace files |
53 } // namespace mojo | 53 } // namespace mojo |
54 | 54 |
55 #endif // SERVICES_FILES_UTIL_H_ | 55 #endif // SERVICES_FILES_UTIL_H_ |
OLD | NEW |