core/os/old package | Odin Programming Language

The original implementation of `core:os`, to be removed in Q2 2026. Cross-platform `OS` interactions like file `I/O`.

Collection Info

Collection: core
Path: os/old
Entries: 146

Constants 55

ARCH ENDIAN ERROR_ACCESS_DENIED ERROR_ALREADY_EXISTS ERROR_BROKEN_PIPE ERROR_BUFFER_OVERFLOW ERROR_DIR_NOT_EMPTY ERROR_ENVVAR_NOT_FOUND ERROR_EOF ERROR_FILE_EXISTS ERROR_FILE_IS_NOT_DIR ERROR_FILE_IS_PIPE ERROR_FILE_NOT_FOUND ERROR_HANDLE_EOF ERROR_INSUFFICIENT_BUFFER ERROR_INVALID_HANDLE +39 more

Types 8

Jump to Types

Errno Error File_Info File_Mode File_Time General_Error Handle Platform_Error

Procedures 75

Jump to Procedures

change_directory clear_env close current_thread_id environ error_string exists exit file_info_delete file_info_slice_delete file_size file_size_from_path flush fstat ftruncate get_current_directory +59 more

Procedure Groups 4

Jump to Procedure Groups

get_env lookup_env read_entire_file read_entire_file_or_err

Variables 4

Jump to Variables

args stderr stdin stdout

Source Files

(hidden platform specific files)

Constants

ARCH #

Source

ARCH :: ODIN_ARCH

ENDIAN #

Source

ENDIAN :: ODIN_ENDIAN

ERROR_ACCESS_DENIED #

Source

ERROR_ACCESS_DENIED :: _Platform_Error(5)

ERROR_ALREADY_EXISTS #

Source

ERROR_ALREADY_EXISTS :: _Platform_Error(183)

ERROR_BROKEN_PIPE #

Source

ERROR_BROKEN_PIPE :: _Platform_Error(109)

ERROR_BUFFER_OVERFLOW #

Source

ERROR_BUFFER_OVERFLOW :: _Platform_Error(111)

ERROR_DIR_NOT_EMPTY #

Source

ERROR_DIR_NOT_EMPTY :: _Platform_Error(145)

ERROR_ENVVAR_NOT_FOUND #

Source

ERROR_ENVVAR_NOT_FOUND :: _Platform_Error(203)

ERROR_EOF #

Source

ERROR_EOF :: io.Error.EOF

ERROR_FILE_EXISTS #

Source

ERROR_FILE_EXISTS :: _Platform_Error(80)

ERROR_FILE_IS_NOT_DIR #

Source

ERROR_FILE_IS_NOT_DIR :: General_Error.Not_Dir

ERROR_FILE_IS_PIPE #

Source

ERROR_FILE_IS_PIPE :: General_Error.File_Is_Pipe

ERROR_FILE_NOT_FOUND #

Source

ERROR_FILE_NOT_FOUND :: _Platform_Error(2)

ERROR_HANDLE_EOF #

Source

ERROR_HANDLE_EOF :: _Platform_Error(38)

ERROR_INSUFFICIENT_BUFFER #

Source

ERROR_INSUFFICIENT_BUFFER :: _Platform_Error(122)

ERROR_INVALID_HANDLE #

Source

ERROR_INVALID_HANDLE :: _Platform_Error(6)

ERROR_INVALID_PARAMETER #

Source

ERROR_INVALID_PARAMETER :: _Platform_Error(87)

ERROR_IO_PENDING #

Source

ERROR_IO_PENDING :: _Platform_Error(997)

ERROR_MOD_NOT_FOUND #

Source

ERROR_MOD_NOT_FOUND :: _Platform_Error(126)

ERROR_MORE_DATA #

Source

ERROR_MORE_DATA :: _Platform_Error(234)

ERROR_NEGATIVE_SEEK #

Source

ERROR_NEGATIVE_SEEK :: _Platform_Error(131)

ERROR_NETNAME_DELETED #

Source

ERROR_NETNAME_DELETED :: _Platform_Error(64)

ERROR_NO_MORE_FILES #

Source

ERROR_NO_MORE_FILES :: _Platform_Error(18)

ERROR_NONE #

Source

ERROR_NONE :: Error{}

ERROR_NOT_ENOUGH_MEMORY #

Source

ERROR_NOT_ENOUGH_MEMORY :: _Platform_Error(8)

ERROR_NOT_FOUND #

Source

ERROR_NOT_FOUND :: _Platform_Error(1168)

ERROR_OPERATION_ABORTED #

Source

ERROR_OPERATION_ABORTED :: _Platform_Error(995)

ERROR_PATH_NOT_FOUND #

Source

ERROR_PATH_NOT_FOUND :: _Platform_Error(3)

ERROR_PRIVILEGE_NOT_HELD #

Source

ERROR_PRIVILEGE_NOT_HELD :: _Platform_Error(1314)

ERROR_PROC_NOT_FOUND #

Source

ERROR_PROC_NOT_FOUND :: _Platform_Error(127)

File_Mode_Char_Device #

Source

File_Mode_Char_Device :: File_Mode(1 << 19)

File_Mode_Device #

Source

File_Mode_Device :: File_Mode(1 << 18)

File_Mode_Dir #

Source

File_Mode_Dir :: File_Mode(1 << 16)

File_Mode_Named_Pipe #

Source

File_Mode_Named_Pipe :: File_Mode(1 << 17)

File_Mode_Sym_Link #

Source

File_Mode_Sym_Link :: File_Mode(1 << 20)

INVALID_HANDLE #

Source

INVALID_HANDLE :: ~Handle(0)

O_APPEND #

Source

O_APPEND :: 0x00400

O_ASYNC #

Source

O_ASYNC :: 0x02000

O_CLOEXEC #

Source

O_CLOEXEC :: 0x80000

O_CREATE #

Source

O_CREATE :: 0x00040

O_EXCL #

Source

O_EXCL :: 0x00080

O_NOCTTY #

Source

O_NOCTTY :: 0x00100

O_NONBLOCK #

Source

O_NONBLOCK :: 0x00800

O_RDONLY #

Source

O_RDONLY :: 0x00000

O_RDWR #

Source

O_RDWR :: 0x00002

O_SYNC #

Source

O_SYNC :: 0x01000

O_TRUNC #

Source

O_TRUNC :: 0x00200

O_WRONLY #

Source

O_WRONLY :: 0x00001

OS #

Source

OS :: ODIN_OS

SEEK_CUR #

Source

SEEK_CUR :: 1

SEEK_END #

Source

SEEK_END :: 2

SEEK_SET #

Source

SEEK_SET :: 0

WINDOWS_11_BUILD_CUTOFF #

Source

WINDOWS_11_BUILD_CUTOFF :: 22_000

Windows 11 (preview) has the same major and minor version numbers as Windows 10: 10 and 0 respectively. To determine if you're on Windows 10 or 11, we need to look at the build number. As far as we can tell right now, the cutoff is build 22_000. TODO: Narrow down this range once Win 11 is published and the last Win 10 builds become available.

WSAEACCES #

Source

WSAEACCES :: _Platform_Error(10013)

WSAECONNRESET #

Source

WSAECONNRESET :: _Platform_Error(10054)

Types

Errno #

Source

Errno :: Error

alias for legacy use

Error #

Source

Error :: Error

File_Info #

Source

File_Info :: File_Info

File_Mode #

Source

File_Mode :: distinct File_Mode

File_Time #

Source

File_Time :: distinct File_Time

General_Error #

Source

General_Error :: General_Error

Handle #

Source

Handle :: distinct Handle

Platform_Error #

Source

Platform_Error :: System_Error

Procedures

change_directory #

Source

change_directory :: proc(path: string) -> (err: Error) {…}

clear_env #

Source

clear_env :: proc() {…}

clear_env deletes all environment variables

close #

Source

close :: proc(fd: Handle) -> Error {…}

current_thread_id #

Source

@(require_results)

current_thread_id :: proc "contextless" () -> int {…}

environ #

Source

@(require_results)

environ :: proc(allocator := context.allocator) -> []string {…}

environ returns a copy of strings representing the environment, in the form "key=value" NOTE: the slice of strings and the strings with be allocated using the supplied allocator

error_string #

Source

@(require_results)

error_string :: proc "contextless" (ferr: Error) -> string {…}

exists #

Source

exists :: proc(path: string) -> bool {…}

exit #

Source

exit :: proc "contextless" (code: int) -> ! {…}

file_info_delete #

Source

file_info_delete :: proc(fi: File_Info, allocator := context.allocator) {…}

file_info_slice_delete #

Source

file_info_slice_delete :: proc(infos: []File_Info, allocator := context.allocator) {…}

file_size #

Source

@(require_results)

file_size :: proc(fd: Handle) -> (i64, Error) {…}

file_size_from_path #

Source

@(require_results)

file_size_from_path :: proc(path: string) -> i64 {…}

flush #

Source

flush :: proc(fd: Handle) -> (err: Error) {…}

fstat #

Source

@(require_results)

fstat :: proc(fd: Handle, allocator := context.allocator) -> (fi: File_Info, err: Error) {…}

ftruncate #

Source

ftruncate :: proc(fd: Handle, length: i64) -> (err: Error) {…}

get_current_directory #

Source

@(require_results)

get_current_directory :: proc(allocator := context.allocator) -> string {…}

get_env_alloc #

Source

@(require_results)

get_env_alloc :: proc(key: string, allocator := context.allocator) -> (value: string) {…}

get_env retrieves the value of the environment variable named by the key It returns the value, which will be empty if the variable is not present To distinguish between an empty value and an unset value, use lookup_env NOTE: the value will be allocated with the supplied allocator

get_env_buf #

Source

@(require_results)

get_env_buf :: proc(buf: []u8, key: string) -> (value: string) {…}

get_last_error #

Source

@(require_results)
@(no_instrumentation)

get_last_error :: proc "contextless" () -> Error {…}

get_page_size #

Source

@(require_results)

get_page_size :: proc() -> int {…}

get_std_handle #

Source

@(require_results)

get_std_handle :: proc "contextless" (h: uint) -> Handle {…}

get_windows_version_w #

Source

@(require_results)

get_windows_version_w :: proc "contextless" () -> OSVERSIONINFOEXW {…}

is_dir #

Source

@(require_results)

is_dir :: proc(path: string) -> bool {…}

is_file #

Source

@(require_results)

is_file :: proc(path: string) -> bool {…}

is_path_separator #

Source

@(require_results)

is_path_separator :: proc(c: u8) -> bool {…}

is_platform_error #

Source

@(require_results)

is_platform_error :: proc "contextless" (ferr: Error) -> (err: i32, ok: bool) {…}

is_windows_10 #

Source

@(require_results)

is_windows_10 :: proc "contextless" () -> bool {…}

is_windows_11 #

Source

@(require_results)

is_windows_11 :: proc "contextless" () -> bool {…}

is_windows_7 #

Source

@(require_results)

is_windows_7 :: proc "contextless" () -> bool {…}

is_windows_8 #

Source

@(require_results)

is_windows_8 :: proc "contextless" () -> bool {…}

is_windows_8_1 #

Source

@(require_results)

is_windows_8_1 :: proc "contextless" () -> bool {…}

is_windows_vista #

Source

@(require_results)

is_windows_vista :: proc "contextless" () -> bool {…}

is_windows_xp #

Source

@(require_results)

is_windows_xp :: proc "contextless" () -> bool {…}

last_write_time #

Source

@(require_results)

last_write_time :: proc(fd: Handle) -> (File_Time, Error) {…}

last_write_time_by_name #

Source

@(require_results)

last_write_time_by_name :: proc(name: string) -> (File_Time, Error) {…}

link #

Source

link :: proc(old_name, new_name: string) -> (err: Error) {…}

lookup_env_alloc #

Source

@(require_results)

lookup_env_alloc :: proc(key: string, allocator := context.allocator) -> (value: string, found: bool) {…}

lookup_env gets the value of the environment variable named by the key If the variable is found in the environment the value (which can be empty) is returned and the boolean is true Otherwise the returned value will be empty and the boolean will be false NOTE: the value will be allocated with the supplied allocator

lookup_env_buffer #

Source

@(require_results)

lookup_env_buffer :: proc(buf: []u8, key: string) -> (value: string, err: Error) {…}

This version of `lookup_env` doesn't allocate and instead requires the user to provide a buffer. Note that it is limited to environment names and values of 512 utf-16 values each due to the necessary utf-8 <> utf-16 conversion.

lstat #

Source

@(require_results)

lstat :: proc(name: string, allocator := context.allocator) -> (File_Info, Error) {…}

make_directory #

Source

make_directory :: proc(path: string, mode: u32 = 0) -> (err: Error) {…}

open #

Source

@(require_results)

open :: proc(path: string, mode: int = O_RDONLY, perm: int = 0) -> (Handle, Error) {…}

pipe #

Source

@(require_results)

pipe :: proc() -> (r, w: Handle, err: Error) {…}

print_error #

Source

print_error :: proc(f: Handle, ferr: Error, msg: string) -> (n: int, err: Error) {…}

processor_core_count #

Source

@(require_results)

processor_core_count :: proc() -> int {…}

read #

Source

read :: proc(fd: Handle, data: []u8) -> (total_read: int, err: Error) {…}

read_at #

Source

read_at :: proc(fd: Handle, data: []u8, offset: i64) -> (n: int, err: Error) {…}

read_at returns n: 0, err: 0 on EOF

read_at_least #

Source

read_at_least :: proc(fd: Handle, buf: []u8, min: int) -> (n: int, err: Error) {…}

read_dir #

Source

@(require_results)

read_dir :: proc(fd: Handle, n: int, allocator := context.allocator) -> (fi: []File_Info, err: Error) {…}

read_entire_file_from_filename #

Source

@(require_results)

read_entire_file_from_filename :: proc(name: string, allocator := context.allocator, loc := #caller_location) -> (data: []u8, success: bool) {…}

read_entire_file_from_filename_or_err #

Source

@(require_results)

read_entire_file_from_filename_or_err :: proc(name: string, allocator := context.allocator, loc := #caller_location) -> (data: []u8, err: Error) {…}

read_entire_file_from_handle #

Source

@(require_results)

read_entire_file_from_handle :: proc(fd: Handle, allocator := context.allocator, loc := #caller_location) -> (data: []u8, success: bool) {…}

read_entire_file_from_handle_or_err #

Source

@(require_results)

read_entire_file_from_handle_or_err :: proc(fd: Handle, allocator := context.allocator, loc := #caller_location) -> (data: []u8, err: Error) {…}

read_full #

Source

read_full :: proc(fd: Handle, buf: []u8) -> (n: int, err: Error) {…}

read_ptr #

Source

read_ptr :: proc(fd: Handle, data: rawptr, len: int) -> (int, Error) {…}

remove #

Source

remove :: proc(name: string) -> Error {…}

remove_directory #

Source

remove_directory :: proc(path: string) -> (err: Error) {…}

rename #

Source

rename :: proc(old_path, new_path: string) -> (err: Error) {…}

replace_environment_placeholders #

Source

replace_environment_placeholders :: proc(path: string, allocator := context.allocator) -> (res: string) {…}

Always allocates for consistency.

seek #

Source

seek :: proc(fd: Handle, offset: i64, whence: int) -> (i64, Error) {…}

set_current_directory #

Source

set_current_directory :: proc(path: string) -> (err: Error) {…}

set_env #

Source

set_env :: proc(key, value: string) -> Error {…}

set_env sets the value of the environment variable named by the key

stat #

Source

@(require_results)

stat :: proc(name: string, allocator := context.allocator) -> (File_Info, Error) {…}

stream_from_handle #

Source

stream_from_handle :: proc(fd: Handle) -> Stream {…}

truncate #

Source

truncate :: proc(path: string, length: i64) -> (err: Error) {…}

unlink #

Source

unlink :: proc(path: string) -> (err: Error) {…}

unset_env #

Source

unset_env :: proc(key: string) -> Error {…}

unset_env unsets a single environment variable

write #

Source

write :: proc(fd: Handle, data: []u8) -> (int, Error) {…}

write_at #

Source

write_at :: proc(fd: Handle, data: []u8, offset: i64) -> (n: int, err: Error) {…}

write_byte #

Source

write_byte :: proc(fd: Handle, b: u8) -> (int, Error) {…}

write_encoded_rune #

Source

write_encoded_rune :: proc(f: Handle, r: rune) -> (n: int, err: Error) {…}

write_entire_file #

Source

write_entire_file :: proc(name: string, data: []u8, truncate: bool = true) -> (success: bool) {…}

write_entire_file_or_err #

Source

@(require_results)

write_entire_file_or_err :: proc(name: string, data: []u8, truncate: bool = true) -> Error {…}

write_ptr #

Source

write_ptr :: proc(fd: Handle, data: rawptr, len: int) -> (int, Error) {…}

write_rune #

Source

write_rune :: proc(fd: Handle, r: rune) -> (int, Error) {…}

write_string #

Source

write_string :: proc(fd: Handle, str: string) -> (int, Error) {…}

Procedure Groups

get_env #

Source

get_env :: proc{
	get_env_alloc,
	get_env_buf,
}

lookup_env #

Source

lookup_env :: proc{
	lookup_env_alloc,
	lookup_env_buffer,
}

read_entire_file #

Source

read_entire_file :: proc{
	read_entire_file_from_filename,
	read_entire_file_from_handle,
}

read_entire_file_or_err #

Source

read_entire_file_or_err :: proc{
	read_entire_file_from_filename_or_err,
	read_entire_file_from_handle_or_err,
}

Variables

args #

Source

args: []string = _alloc_command_line_arguments()

"Argv" arguments converted to Odin strings

stderr #

Source

stderr: Handle = get_std_handle(uint(win32.STD_ERROR_HANDLE))

stdin #

Source

stdin: Handle = get_std_handle(uint(win32.STD_INPUT_HANDLE))

NOTE(bill): Uses startup to initialize it

stdout #

Source

stdout: Handle = get_std_handle(uint(win32.STD_OUTPUT_HANDLE))