phoenix/src/filesystem/FileSystemError.js at pluto/git-ff · phcode-dev/phoenix · GitHub

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
 * GNU AGPL-3.0 License
 *
 * Copyright (c) 2021 - present core.ai . All rights reserved.
 * Original work Copyright (c) 2013 - 2021 Adobe Systems Incorporated. All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.
 *
 */

// @INCLUDE_IN_API_DOCS

define(function (require, exports, module) {

    /**
     *
     *
     * FileSystemError describes the errors that can occur when using the FileSystem, File,
     * and Directory modules.
     *
     * Error values are strings. Any "falsy" value: null, undefined or "" means "no error".
     *
     * Enumerated File System Errors
     *
     * ```js
     *         UNKNOWN: "Unknown",
     *         INVALID_PARAMS: "InvalidParams",
     *         NOT_FOUND: "NotFound",
     *         NOT_READABLE: "NotReadable",
     *         UNSUPPORTED_ENCODING: "UnsupportedEncoding",
     *         NOT_SUPPORTED: "NotSupported",
     *         NOT_WRITABLE: "NotWritable",
     *         OUT_OF_SPACE: "OutOfSpace",
     *         TOO_MANY_ENTRIES: "TooManyEntries",
     *         ALREADY_EXISTS: "AlreadyExists",
     *         CONTENTS_MODIFIED: "ContentsModified",
     *         ROOT_NOT_WATCHED: "RootNotBeingWatched",
     *         EXCEEDS_MAX_FILE_SIZE: "ExceedsMaxFileSize",
     *         NETWORK_DRIVE_NOT_SUPPORTED: "NetworkDriveNotSupported",
     *         ENCODE_FILE_FAILED: "EncodeFileFailed",
     *         DECODE_FILE_FAILED: "DecodeFileFailed",
     *         UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"
     *  ```
     *
     * @module FileSystemError
     */
    module.exports = {
        UNKNOWN: "Unknown",
        INVALID_PARAMS: "InvalidParams",
        NOT_FOUND: "NotFound",
        NOT_READABLE: "NotReadable",
        UNSUPPORTED_ENCODING: "UnsupportedEncoding",
        NOT_SUPPORTED: "NotSupported",
        NOT_WRITABLE: "NotWritable",
        OUT_OF_SPACE: "OutOfSpace",
        TOO_MANY_ENTRIES: "TooManyEntries",
        ALREADY_EXISTS: "AlreadyExists",
        CONTENTS_MODIFIED: "ContentsModified",
        ROOT_NOT_WATCHED: "RootNotBeingWatched",
        EXCEEDS_MAX_FILE_SIZE: "ExceedsMaxFileSize",
        NETWORK_DRIVE_NOT_SUPPORTED: "NetworkDriveNotSupported",
        ENCODE_FILE_FAILED: "EncodeFileFailed",
        DECODE_FILE_FAILED: "DecodeFileFailed",
        UNSUPPORTED_UTF16_ENCODING: "UnsupportedUTF16Encoding"

        // FUTURE: Add remote connection errors: timeout, not logged in, connection err, etc.
    };
});