package luv

  1. Overview
  2. Docs
package luv
Legend:
Library
Module
Module type
Parameter
Class
Class type

Consoles.

See uv_tty_t — TTY handle in libuv.

type t = [ `TTY ] Stream.t

Binds http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_t.

Note that values of this type can also be used with functions in:

In particular, see Luv.Handle.close, Luv.Stream.read_start, and Luv.Stream.write.

val init : ?loop:Loop.t -> File.t -> (t, Error.t) result

Allocates and initializes a TTY handle.

Binds uv_tty_init.

module Mode : sig ... end

Binds uv_tty_mode_t.

val set_mode : t -> Mode.t -> (unit, Error.t) result

Sets the TTY's mode.

Binds uv_tty_set_mode.

val reset_mode : unit -> (unit, Error.t) result

Resets the TTY's mode.

Binds uv_tty_reset_mode.

val get_winsize : t -> (int * int, Error.t) result

Retrieves the current window size.

Binds uv_tty_get_winsize.

module Vterm_state : sig ... end

Binds uv_tty_vtermstate_t.

val set_vterm_state : Vterm_state.t -> unit

Binds uv_tty_set_vterm_state.

Requires libuv 1.33.0.

Feature check: Luv.Require.(has tty_vterm_state)

val get_vterm_state : unit -> (Vterm_state.t, Error.t) result

Binds uv_tty_get_vterm_state.

Requires libuv 1.33.0.

Feature check: Luv.Require.(has tty_vterm_state)

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