package containers

  1. Overview
  2. Docs
package containers
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t = 'a list * 'a list
val empty : 'a t

Empty zipper

val is_empty : _ t -> bool

Empty zipper, or at the end of the zipper?

val to_list : 'a t -> 'a list

Convert the zipper back to a list

val make : 'a list -> 'a t

Create a zipper pointing at the first element of the list

val left : 'a t -> 'a t

Go to the left, or do nothing if the zipper is already at leftmost pos

val right : 'a t -> 'a t

Go to the right, or do nothing if the zipper is already at rightmost pos

val modify : ('a option -> 'a option) -> 'a t -> 'a t

Modify the current element, if any, by returning a new element, or returning None if the element is to be deleted

val focused : 'a t -> 'a option

Returns the focused element, if any. focused zip = Some _ iff empty zip = false

val focused_exn : 'a t -> 'a

Returns the focused element, or

  • raises Not_found

    if the zipper is at an end

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct