end

Flushes any buffered data and sets the end position of the file.

If not overwriting existing contents, then calling interface.flush directly is sufficient.

Flush failure is handled by setting err so that it can be handled along with other write failures.

Function parameters

Parameters

w:*Writer

Type definitions in this namespace

Types

Kind
OpenMode
Lock
OpenFlags
CreateFlags
Stat
Permissions: Cross-platform representation of permissions on a file.
PermissionsWindows
PermissionsUnix
Reader: Memoizes key information about a file handle such as:
Writer

Functions in this namespace

Functions

stdout
stderr
stdin
close: Upon success, the stream is in an uninitialized state.
sync: Blocks until all pending file contents and metadata modifications
isTty: Test whether the file refers to a terminal.
isCygwinPty
getOrEnableAnsiEscapeSupport: Returns whether or not ANSI escape codes will be treated as such,
supportsAnsiEscapeCodes: Test whether ANSI escape codes will be treated as such without
setEndPos: Shrinks or expands the file.
seekBy: Repositions read/write file offset relative to the current offset.
seekFromEnd: Repositions read/write file offset relative to the end.
seekTo: Repositions read/write file offset relative to the beginning.
getPos: TODO: integrate with async I/O
getEndPos: TODO: integrate with async I/O
mode: TODO: integrate with async I/O
stat: Returns `Stat` containing basic information about the `File`.
chmod: Changes the mode of the file.
chown: Changes the owner and group of the file.
setPermissions: Sets permissions according to the provided `Permissions` struct.
updateTimes: The underlying file system may have a different granularity than nanoseconds,
readToEndAlloc: Deprecated in favor of `Reader`.
readToEndAllocOptions: Deprecated in favor of `Reader`.
read
readAll: Deprecated in favor of `Reader`.
pread: On Windows, this function currently does alter the file pointer.
preadAll: Deprecated in favor of `Reader`.
readv: See https://github.com/ziglang/zig/issues/7699
readvAll: Deprecated in favor of `Reader`.
preadv: See https://github.com/ziglang/zig/issues/7699
preadvAll: Deprecated in favor of `Reader`.
write
writeAll: Deprecated in favor of `Writer`.
pwrite: On Windows, this function currently does alter the file pointer.
pwriteAll: Deprecated in favor of `Writer`.
writev: See https://github.com/ziglang/zig/issues/7699
writevAll: Deprecated in favor of `Writer`.
pwritev: See https://github.com/ziglang/zig/issues/7699
pwritevAll: Deprecated in favor of `Writer`.
copyRange: Deprecated in favor of `Writer`.
copyRangeAll: Deprecated in favor of `Writer`.
deprecatedReader: Deprecated in favor of `Reader`.
deprecatedWriter: Deprecated in favor of `Writer`.
reader: Defaults to positional reading; falls back to streaming.
readerStreaming: Positional is more threadsafe, since the global seek position is not
writer: Defaults to positional reading; falls back to streaming.
writerStreaming: Positional is more threadsafe, since the global seek position is not
lock: Blocks when an incompatible lock is held by another process.
unlock: Assumes the file is locked.
tryLock: Attempts to obtain a lock, returning `true` if the lock is
downgradeLock: Assumes the file is already locked in exclusive mode.

Error sets in this namespace

Error Sets

OpenError
SyncError
SetEndPosError
SeekError
GetSeekPosError
GetEndPosError
ModeError
StatError
ChmodError
ChownError
SetPermissionsError
UpdateTimesError
ReadError
PReadError
WriteError
PWriteError
CopyRangeError
LockError

= posix.fd_t

Values

Handle: = posix.fd_t
Mode: = posix.mode_t
INode: = posix.ino_t
Uid: = posix.uid_t
Gid: = posix.gid_t
default_mode: This is the default mode given to POSIX operating systems for creating

Source

Implementation

pub fn end(w: *Writer) EndError!void {
    try w.interface.flush();
    switch (w.mode) {
        .positional,
        .positional_reading,
        => w.file.setEndPos(w.pos) catch |err| switch (err) {
            error.NonResizable => return,
            else => |e| return e,
        },

        .streaming,
        .streaming_reading,
        .failure,
        => {},
    }
}