Standard Library Reference

The Zen standard library (@std) provides core functionalities for common programming tasks. These modules are accessible via the @std namespace, allowing for modular and expressive imports.

---

@std.io - Input/Output Module

The io module provides functions for console input and output.

Functions

• fn print(message: String): void
• fn println(message: String): void
• fn eprint(message: String): void
• fn eprintln(message: String): void
• fn read_line(): Result<String, String>
• fn read_input(prompt: String): Result<String, String>

Types

No types explicitly defined by this module.

---

@std.math - Mathematical Operations Module

The math module provides common mathematical functions.

Functions

• fn abs(value: f64): f64
• fn sqrt(value: f64): f64
• fn pow(base: f64, exp: f64): f64
• fn sin(angle: f64): f64
• fn cos(angle: f64): f64
• fn tan(angle: f64): f64
• fn log(value: f64): f64
• fn log10(value: f64): f64
• fn exp(value: f64): f64
• fn floor(value: f64): f64
• fn ceil(value: f64): f64
• fn round(value: f64): f64
• fn min(a: f64, b: f64): f64
• fn max(a: f64, b: f64): f64

Types

No types explicitly defined by this module.

---

@std.string - String Manipulation Module

The string module offers utility functions for working with dynamic strings.

Functions

• fn len(str: String): i64
• fn concat(a: String, b: String): String
• fn substring(str: String, start: i64, end: i64): String
• fn contains(str: String, pattern: String): bool
• fn starts_with(str: String, prefix: String): bool
• fn ends_with(str: String, suffix: String): bool
• fn replace(str: String, old: String, new: String): String
• fn split(str: String, delimiter: String): Vec<String>
• fn trim(str: String): String
• fn to_upper(str: String): String
• fn to_lower(str: String): String
• fn format(template: String): String
• fn to_i32(str: String): Option<i32>
• fn to_i64(str: String): Option<i64>
• fn to_f32(str: String): Option<f32>
• fn to_f64(str: String): Option<f64>

Types

No types explicitly defined by this module.

---

@std.vec - Vector/Dynamic Array Module

The vec module provides functions and types for dynamic and fixed-size vectors.

Functions

• fn new(): Vec<T>
• fn with_capacity(capacity: i64): Vec<T>
• fn push(vec: Vec<T>, value: T): void
• fn pop(vec: Vec<T>): Option<T>
• fn len(vec: Vec<T>): i64
• fn is_empty(vec: Vec<T>): bool
• fn clear(vec: Vec<T>): void
• fn get(vec: Vec<T>, index: i64): Option<T>
• fn insert(vec: Vec<T>, index: i64, value: T): void
• fn remove(vec: Vec<T>, index: i64): T

Types

• Vec<T>: A generic vector type.

---

@std.fs - Filesystem Module

The fs module offers operations for interacting with the filesystem.

Functions

• fn read_file(path: String): Result<String, String>
• fn write_file(path: String, content: String): Result<void, String>
• fn append_file(path: String, content: String): Result<void, String>
• fn exists(path: String): bool
• fn is_file(path: String): bool
• fn is_directory(path: String): bool
• fn create_dir(path: String): Result<void, String>
• fn create_dir_all(path: String): Result<void, String>
• fn remove_file(path: String): Result<void, String>
• fn remove_dir(path: String): Result<void, String>
• fn remove_dir_all(path: String): Result<void, String>
• fn copy(from: String, to: String): Result<i64, String>
• fn rename(from: String, to: String): Result<void, String>
• fn metadata(path: String): Result<FileMetadata, String>
• fn read_dir(path: String): Result<Vec<String>, String>

Types

• FileMetadata: A generic type representing file metadata.
• Path: A generic type representing a filesystem path.

---

@std.net - Network Module

The net module provides functionalities for TCP and UDP networking.

Functions

• fn tcp_listen(port: u16): Result<TcpSocket, Error>
• fn tcp_accept(listener: Ptr<TcpSocket>): Result<Connection, Error>
• fn tcp_connect(host: String, port: u16): Result<TcpSocket, Error>
• fn tcp_send(socket: Ptr<TcpSocket>, data: Ptr<u8>, len: u64): i64
• fn tcp_recv(socket: Ptr<TcpSocket>, buffer: Ptr<u8>, len: u64): i64
• fn udp_socket(): Result<UdpSocket, Error>
• fn udp_bind(socket: Ptr<UdpSocket>, port: u16): i32
• fn udp_sendto(socket: Ptr<UdpSocket>, data: Ptr<u8>, len: u64, host: String, port: u16): i64
• fn udp_recvfrom(socket: Ptr<UdpSocket>, buffer: Ptr<u8>, len: u64): RecvResult
• fn socket_close(fd: i32): i32
• fn make_sockaddr(host: String, port: u16): SockAddr

Types

• SockAddr: Represents a socket address.

• TcpSocket: A wrapper for a TCP socket file descriptor.

• UdpSocket: A wrapper for a UDP socket file descriptor.

• Connection: Represents an established network connection.

• RecvResult: (Implicitly defined by udp_recvfrom return type) Likely a struct containing bytes received, source address, and port.

---

@std.build - Build System Module

The build module provides functions for interacting with the Zen build system.

Functions

• fn import(module_name: String): Module
• fn default_config(): BuildConfig
• fn compile_file(path: String, config: BuildConfig): BuildResult
• fn build_project(config: BuildConfig): BuildResult
• fn compiler_version(): String
• fn target_triple(): String
• fn has_feature(feature: String): bool

Types

• BuildConfig: A generic type representing build configuration.
• BuildResult: A generic type representing the result of a build operation.
• Module: A generic type representing a loaded module.
• CompilationUnit: A generic type representing a compilation unit.

---

@std.compiler - Compiler Intrinsics Module

The compiler module provides low-level intrinsics for direct compiler interaction. Use with caution.

Functions

• fn inline_c(code: StaticString): void
• fn raw_allocate(size: usize): Ptr<u8>
• fn raw_deallocate(ptr: Ptr<u8>, size: usize): void
• fn raw_reallocate(ptr: Ptr<u8>, old_size: usize, new_size: usize): Ptr<u8>
• fn raw_ptr_offset(ptr: RawPtr<u8>, offset: i64): RawPtr<u8>
• fn raw_ptr_cast(ptr: RawPtr<u8>): RawPtr<u8>
• fn call_external(func_ptr: RawPtr<u8>, args: RawPtr<u8>): RawPtr<u8>
• fn load_library(path: StaticString): RawPtr<u8>
• fn get_symbol(lib_handle: RawPtr<u8>, symbol_name: StaticString): RawPtr<u8>
• fn unload_library(lib_handle: RawPtr<u8>): void

Types

No types explicitly defined by this module.

---

@std.core - Core Language Module

The core module provides fundamental types and compiler intrinsics.

Functions

• fn size_of(T): u64
• fn min(a: i64, b: i64): i64
• fn max(a: i64, b: i64): i64
• fn abs(n: i64): i64
• fn clamp(value: i64, min: i64, max: i64): i64
• fn align_of(T): u64
• fn type_name(T): String
• fn panic(message: String): void
• fn assert(condition: bool): void

Types

• type: A generic meta-type.
• Any: A generic type representing any type.
• Result<T, E>: The result type for error handling. (See @std.result for details).
• Option<T>: The option type for nullable values. (See @std.result for details).
• Range: A generic type for ranges.

---

@std.result - Result and Option Types Module

The result module provides the core Result and Option enum types for robust error handling and nullable values in Zen.

Types

• Result<T, E>: Represents a computation that may either succeed or fail.
  • Ok: T: The success variant, containing a value of type T.
  • Err: E: The failure variant, containing an error value of type E.

• Option<T>: Represents an optional value; every Option is either Some and contains a value, or None, and does not.
  • Some: T: The variant containing a value of type T.
  • None: The variant indicating no value.

Helper Functions (Constructors & Patterns)

The following functions are available as constructors or patterns, often used directly on the Result or Option type.

• Ok(value: T): Creates a Result.Ok variant.
• Err(error: E): Creates a Result.Err variant.
• Some(value: T): Creates an Option.Some variant.
• None: Creates an Option.None variant.

---