Stdlib.Stack(3)

🌸 Stdlib.Stack(3) 🌸

okay so this is the Stdlib.Stack page from the OCaml library, bestie — manual name folded in right here so we didn't have to copy that crusty header line, periodt. ✨

💖 NAME 💖

Stdlib.Stack - no description. That's it. That's the whole name section. Mysterious main character energy, honestly 😭.

🧚 Module 🧚

Module Stdlib.Stack

🎀 Documentation 🎀

Here's the module line exactly as the page gives it: Module Stack : (module Stdlib__Stack).

🚨 Unsynchronized accesses 🚨

🚨 Warning, bestie: Unsynchronized accesses to a stack may lead to an invalid queue state. Thus, concurrent accesses to stacks must be synchronized (for instance with a Mutex.t). This is not a drill — the manual literally says it. 💀

• type !'a t — the type of stacks containing elements of type 'a. 🦋
• exception Empty — raised when Stack.pop or Stack.top is applied to an empty stack. 😭
• val create : unit -> 'a t — return a new stack, initially empty. ✨
• val push : 'a -> 'a t -> unit — push x s adds the element x at the top of stack s. 💅
• val pop : 'a t -> 'a — pop s removes and returns the topmost element in stack s, or raises Stack.Empty if the stack is empty. 🫶
• val pop_opt : 'a t -> 'a option — pop_opt s removes and returns the topmost element in stack s, or returns None if the stack is empty. Since 4.08. 🎀
• val drop : 'a t -> unit — drop s removes the topmost element in stack s, or raises Stack.Empty if the stack is empty. Since 5.1. 🔥
• val top : 'a t -> 'a — top s returns the topmost element in stack s, or raises Stack.Empty if the stack is empty. 👑
• val top_opt : 'a t -> 'a option — top_opt s returns the topmost element in stack s, or None if the stack is empty. Since 4.08. 🌈
• val clear : 'a t -> unit — discard all elements from a stack. 🧹
• val copy : 'a t -> 'a t — return a copy of the given stack. 🧚
• val is_empty : 'a t -> bool — return true if the given stack is empty, false otherwise. 💜
• val length : 'a t -> int — return the number of elements in a stack. Time complexity O(1). ⭐
• val iter : ('a -> unit) -> 'a t -> unit — iter f s applies f in turn to all elements of s, from the element at the top of the stack to the element at the bottom of the stack. The stack itself is unchanged. 💖
• val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc — fold f accu s is (f (... (f (f accu x1) x2) ...) xn) where x1 is the top of the stack, x2 the second element, and xn the bottom element. The stack is unchanged. Since 4.03. 🌸

🦋 Stacks and Sequences 🦋

• val to_seq : 'a t -> 'a Seq.t — iterate on the stack, top to bottom. It is safe to modify the stack during iteration. Since 4.07. ✨
• val add_seq : 'a t -> 'a Seq.t -> unit — add the elements from the sequence on the top of the stack. Since 4.07. 🎀
• val of_seq : 'a Seq.t -> 'a t — create a stack from the sequence. Since 4.07. 🦋

🫶 That's the whole page, bestie. Signed off by OCamldoc, dated 2026-06-22, and filed under Stdlib.Stack(3). Mwah! 💋