package ecaml

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

A background job is an Async job that the emacs UI is not blocking on. These jobs are special -- they can only interact with the UI in limited ways to avoid interfering with blocking jobs, or with the user. For example, background jobs may not change the current buffer.

val don't_wait_for : Core.Source_code_position.t -> (unit -> unit Async.Deferred.t) -> unit

don't_wait_for here f is like Async.don't_wait_for, except that it marks all jobs created by running f as background jobs.

val schedule_foreground_block_on_async : Core.Source_code_position.t -> (unit -> unit Async.Deferred.t) -> unit

From a background job, become a foreground job. We implement this by waiting until no other foreground jobs are running, then blocking emacs until the Deferred.t is resolved.

module Clock : sig ... end
val assert_foreground : ?message:Async.Sexp.t -> Core.Source_code_position.t -> unit

If this is called in a background Async job, raise an exception.

val currently_running_in_background : unit -> Core.Source_code_position.t option

Return Some location when the current Async job is a background job. location is the Source_code_position.t describing where the job was originally tagged as running in the background.

val am_running_in_background : unit -> bool
val am_running_in_foreground : unit -> bool
module Private : sig ... 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