File: FileType.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (172 lines) | stat: -rw-r--r-- 4,332 bytes parent folder | download
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2023 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS) || os(Linux) || os(Android)
import SystemPackage

#if canImport(Darwin)
import Darwin
#elseif canImport(Glibc)
import Glibc
#elseif canImport(Musl)
import Musl
#endif

/// The type of a file system object.
public struct FileType: Hashable, Sendable {
    internal enum Wrapped: Hashable, Sendable, CaseIterable {
        case regular
        case block
        case character
        case fifo
        case directory
        case symlink
        case socket
        case whiteout
        case unknown
    }

    internal let wrapped: Wrapped
    private init(_ wrapped: Wrapped) {
        self.wrapped = wrapped
    }
}

extension FileType {
    /// Regular file.
    public static var regular: Self { Self(.regular) }

    /// Directory.
    public static var directory: Self { Self(.directory) }

    /// Symbolic link.
    public static var symlink: Self { Self(.symlink) }

    /// Hardware block device.
    public static var block: Self { Self(.block) }

    /// Hardware character device.
    public static var character: Self { Self(.character) }

    /// FIFO (or named pipe).
    public static var fifo: Self { Self(.fifo) }

    /// Socket.
    public static var socket: Self { Self(.socket) }

    /// Whiteout file.
    public static var whiteout: Self { Self(.whiteout) }

    /// A file of unknown type.
    public static var unknown: Self { Self(.unknown) }
}

extension FileType: CustomStringConvertible {
    public var description: String {
        switch self.wrapped {
        case .regular:
            return "regular"
        case .block:
            return "block"
        case .character:
            return "character"
        case .fifo:
            return "fifo"
        case .directory:
            return "directory"
        case .symlink:
            return "symlink"
        case .socket:
            return "socket"
        case .whiteout:
            return "whiteout"
        case .unknown:
            return "unknown"
        }
    }
}

extension FileType: CaseIterable {
    public static var allCases: [FileType] {
        Self.Wrapped.allCases.map { FileType($0) }
    }
}

extension FileType {
    /// Initializes a file type from a `CInterop.Mode`.
    ///
    /// Note: an appropriate mask is applied to `mode`.
    public init(platformSpecificMode: CInterop.Mode) {
        // See: `man 2 stat`
        switch platformSpecificMode & S_IFMT {
        case S_IFIFO:
            self = .fifo
        case S_IFCHR:
            self = .character
        case S_IFDIR:
            self = .directory
        case S_IFBLK:
            self = .block
        case S_IFREG:
            self = .regular
        case S_IFLNK:
            self = .symlink
        case S_IFSOCK:
            self = .socket
        #if canImport(Darwin)
        case S_IFWHT:
            self = .whiteout
        #endif
        default:
            self = .unknown
        }
    }

    /// Initializes a file type from the `d_type` from `dirent`.
    @_spi(Testing)
    public init(direntType: UInt8) {
        #if canImport(Darwin) || canImport(Musl) || os(Android)
        let value = Int32(direntType)
        #elseif canImport(Glibc)
        let value = Int(direntType)
        #endif

        switch value {
        case DT_FIFO:
            self = .fifo
        case DT_CHR:
            self = .character
        case DT_DIR:
            self = .directory
        case DT_BLK:
            self = .block
        case DT_REG:
            self = .regular
        case DT_LNK:
            self = .symlink
        case DT_SOCK:
            self = .socket
        #if canImport(Darwin)
        case DT_WHT:
            self = .whiteout
        #endif
        case DT_UNKNOWN:
            self = .unknown
        default:
            self = .unknown
        }
    }
}

#endif