One Logo Pool Ball
System · IOS API REFERENCE

FilePermissions

struct · iOS 14.0+ · SDK 27.1

@frozen struct FilePermissions

The access permissions for a file. The following example creates an instance of the `FilePermissions` structure from a raw octal literal and compares it to a file permission created using named options: let perms = FilePermissions(rawValue: 0o644) perms == [.ownerReadWrite, .groupRead, .otherRead] // true

Members (28)

get · iOS 14.0+

groupWrite

TypeScript
get groupWrite(): FilePermissions
Swift declaration
static var groupWrite: FilePermissions { get }

Indicates that the group has write-only permission.

get · iOS 14.0+

otherWrite

TypeScript
get otherWrite(): FilePermissions
Swift declaration
static var otherWrite: FilePermissions { get }

Indicates that other users have write-only permission.

get · iOS 14.0+

ownerWrite

TypeScript
get ownerWrite(): FilePermissions
Swift declaration
static var ownerWrite: FilePermissions { get }

Indicates that the owner has write-only permission.

get · iOS 14.0+

setGroupID

TypeScript
get setGroupID(): FilePermissions
Swift declaration
static var setGroupID: FilePermissions { get }

Indicates that the file is executed as the group. For more information, see the `setgid(2)` man page.

get · iOS 14.0+

description

TypeScript
getDescription($self: FilePermissions): string
Swift declaration
var description: String { get }

A textual representation of the file permissions.

get · iOS 14.0+

groupExecute

TypeScript
get groupExecute(): FilePermissions
Swift declaration
static var groupExecute: FilePermissions { get }

Indicates that the group has execute-only permission.

get · iOS 14.0+

otherExecute

TypeScript
get otherExecute(): FilePermissions
Swift declaration
static var otherExecute: FilePermissions { get }

Indicates that other users have execute-only permission.

get · iOS 14.0+

ownerExecute

TypeScript
get ownerExecute(): FilePermissions
Swift declaration
static var ownerExecute: FilePermissions { get }

Indicates that the owner has execute-only permission.

get · iOS 14.0+

groupReadWrite

TypeScript
get groupReadWrite(): FilePermissions
Swift declaration
static var groupReadWrite: FilePermissions { get }

Indicates that the group has read-write permission.

get · iOS 14.0+

otherReadWrite

TypeScript
get otherReadWrite(): FilePermissions
Swift declaration
static var otherReadWrite: FilePermissions { get }

Indicates that other users have read-write permission.

get · iOS 14.0+

ownerReadWrite

TypeScript
get ownerReadWrite(): FilePermissions
Swift declaration
static var ownerReadWrite: FilePermissions { get }

Indicates that the owner has read-write permission.

get · iOS 14.0+

debugDescription

TypeScript
getDebugDescription($self: FilePermissions): string
Swift declaration
var debugDescription: String { get }

A textual representation of the file permissions, suitable for debugging.

get · iOS 14.0+

groupReadExecute

TypeScript
get groupReadExecute(): FilePermissions
Swift declaration
static var groupReadExecute: FilePermissions { get }

Indicates that the group has read-execute permission.

get · iOS 14.0+

otherReadExecute

TypeScript
get otherReadExecute(): FilePermissions
Swift declaration
static var otherReadExecute: FilePermissions { get }

Indicates that other users have read-execute permission.

get · iOS 14.0+

ownerReadExecute

TypeScript
get ownerReadExecute(): FilePermissions
Swift declaration
static var ownerReadExecute: FilePermissions { get }

Indicates that the owner has read-execute permission.

get · iOS 14.0+

groupWriteExecute

TypeScript
get groupWriteExecute(): FilePermissions
Swift declaration
static var groupWriteExecute: FilePermissions { get }

Indicates that the group has write-execute permission.

get · iOS 14.0+

otherWriteExecute

TypeScript
get otherWriteExecute(): FilePermissions
Swift declaration
static var otherWriteExecute: FilePermissions { get }

Indicates that other users have write-execute permission.

get · iOS 14.0+

ownerWriteExecute

TypeScript
get ownerWriteExecute(): FilePermissions
Swift declaration
static var ownerWriteExecute: FilePermissions { get }

Indicates that the owner has write-execute permission.

get · iOS 14.0+

groupReadWriteExecute

TypeScript
get groupReadWriteExecute(): FilePermissions
Swift declaration
static var groupReadWriteExecute: FilePermissions { get }

Indicates that the group has read, write, and execute permission.

get · iOS 14.0+

otherReadWriteExecute

TypeScript
get otherReadWriteExecute(): FilePermissions
Swift declaration
static var otherReadWriteExecute: FilePermissions { get }

Indicates that other users have read, write, and execute permission.

get · iOS 14.0+

ownerReadWriteExecute

TypeScript
get ownerReadWriteExecute(): FilePermissions
Swift declaration
static var ownerReadWriteExecute: FilePermissions { get }

Indicates that the owner has read, write, and execute permission.

init · iOS 14.0+

init

TypeScript
init(rawValue: SDKHandle): FilePermissions
Swift declaration
init(rawValue: CModeT)

Create a strongly-typed file permission from a raw C value.

get · iOS 14.0+

rawValue

TypeScript
getRawValue($self: FilePermissions): SDKHandle
Swift declaration
let rawValue: CModeT

The raw C file permissions.

get · iOS 14.0+

saveText

TypeScript
get saveText(): FilePermissions
Swift declaration
static var saveText: FilePermissions { get }

Indicates that executable's text segment should be kept in swap space even after it exits. For more information, see the `chmod(2)` man page's discussion of `S_ISVTX` (the sticky bit).

get · iOS 14.0+

groupRead

TypeScript
get groupRead(): FilePermissions
Swift declaration
static var groupRead: FilePermissions { get }

Indicates that the group has read-only permission.

get · iOS 14.0+

otherRead

TypeScript
get otherRead(): FilePermissions
Swift declaration
static var otherRead: FilePermissions { get }

Indicates that other users have read-only permission.

get · iOS 14.0+

ownerRead

TypeScript
get ownerRead(): FilePermissions
Swift declaration
static var ownerRead: FilePermissions { get }

Indicates that the owner has read-only permission.

get · iOS 14.0+

setUserID

TypeScript
get setUserID(): FilePermissions
Swift declaration
static var setUserID: FilePermissions { get }

Indicates that the file is executed as the owner. For more information, see the `setuid(2)` man page.

Skipped declarations

No declarations were skipped in this snapshot.

All System types →