System · IOS API REFERENCE

FileDescriptor.SeekOrigin

struct · iOS 14.0+ · SDK 27.1

@frozen struct SeekOrigin

Options for specifying what a file descriptor's offset is relative to.

Members (10)

get · iOS 14.0+

description

TypeScript

getDescription($self: FileDescriptor_SeekOrigin): string

Swift declaration

var description: String { get }

A textual representation of the seek origin.

get · iOS 14.0+

debugDescription

TypeScript

getDebugDescription($self: FileDescriptor_SeekOrigin): string

Swift declaration

var debugDescription: String { get }

A textual representation of the seek origin, suitable for debugging.

get · iOS 14.0+

end

TypeScript

get end(): FileDescriptor_SeekOrigin

Swift declaration

static var end: FileDescriptor.SeekOrigin { get }

Indicates that the offset should be set to the size of the file plus the specified number of bytes. The corresponding C constant is `SEEK_END`.

get · iOS 14.0+

start

TypeScript

get start(): FileDescriptor_SeekOrigin

Swift declaration

static var start: FileDescriptor.SeekOrigin { get }

Indicates that the offset should be set to the specified value. The corresponding C constant is `SEEK_SET`.

get · iOS 14.0+

current

TypeScript

get current(): FileDescriptor_SeekOrigin

Swift declaration

static var current: FileDescriptor.SeekOrigin { get }

Indicates that the offset should be set to the specified number of bytes after the current location. The corresponding C constant is `SEEK_CUR`.

get · iOS 14.0+

nextData

TypeScript

get nextData(): FileDescriptor_SeekOrigin

Swift declaration

static var nextData: FileDescriptor.SeekOrigin { get }

Indicates that the offset should be set to the start of the next file region that isn't a hole and is greater than or equal to the supplied offset. The corresponding C constant is `SEEK_DATA`.

get · iOS 14.0+

nextHole

TypeScript

get nextHole(): FileDescriptor_SeekOrigin

Swift declaration

static var nextHole: FileDescriptor.SeekOrigin { get }

Indicates that the offset should be set to the next hole after the specified number of bytes. For information about what is considered a hole, see the `lseek(2)` man page. The corresponding C constant is `SEEK_HOLE`.

init · iOS 14.0+

init

TypeScript

init(rawValue: number): FileDescriptor_SeekOrigin

Swift declaration

init(rawValue: CInt)

Create a strongly-typed seek origin from a raw C value.

get · iOS 14.0+

rawValue

TypeScript

getRawValue($self: FileDescriptor_SeekOrigin): number

Swift declaration

var rawValue: CInt

The raw C value.

set · iOS 14.0+

rawValue

TypeScript

setRawValue($self: FileDescriptor_SeekOrigin, value: number): void

Swift declaration

var rawValue: CInt

The raw C value.

Skipped declarations

No declarations were skipped in this snapshot.

All System types →