eh_channel.dhover×45all
#!/usr/bin/env dub
/+ dub.sdl:
    name "eh_channel"
    dependency "sparkles:event-horizon" path="../../../../.."
    buildType "checked" {
        buildOptions "optimize" "inline" "debugInfo"
    }
    platforms "linux"
+/
import 
(package) core
core
.
(module) core.time

Module containing core time functionality, such as Duration (which represents a duration of time) or MonoTime (which represents a timestamp of the system's monotonic clock).

Various functions take a string (or strings) to represent a unit of time (e.g. convert!("days", "hours")(numDays)). The valid strings to use with such functions are "years", "months", "weeks", "days", "hours", "minutes", "seconds", "msecs" (milliseconds), "usecs" (microseconds), "hnsecs" (hecto-nanoseconds - i.e. 100 ns) or some subset thereof. There are a few functions that also allow "nsecs", but very little actually has precision greater than hnsecs.

Symbol Description
Types
Duration Represents a duration of time of weeks or less (kept internally as hnsecs). (e.g. 22 days or 700 seconds).
TickDuration DEPRECATED Represents a duration of time in system clock ticks, using the highest precision that the system provides.
MonoTime Represents a monotonic timestamp in system clock ticks, using the highest precision that the system provides.
Functions
convert Generic way of converting between two time units.
dur Allows constructing a Duration from the given time units with the given length.
weeks days hours

minutes seconds msecs

usecs hnsecs nsecs | Convenience aliases for dur. | | abs | Returns the absolute value of a duration. |

From Duration
From TickDuration
From units
To Duration
tickDuration.to, std,conv!Duration()
dur!"msecs"(5) or 5.msecs()

| To TickDuration | duration.to, std,conv!TickDuration() |

  • | TickDuration.from!"msecs"(msecs) |

| To units | duration.total!"days" | tickDuration.msecs | convert!("days", "msecs")(msecs) |

Source

core/time.d

@copyrightCopyright 2010 - 2012@licenseBoost License 1.0.@authorsJonathan M Davis and Kato Shoichi
time
: msecs;
import
(package) core
core
.
(package) core.stdc
stdc
.
(module) core.stdc.errno

D header file for C99.

pubs.opengroup.org/onlinepubs/009695399/basedefs/errno.h.html, errno.h

Source

core/stdc/errno.d

@copyrightCopyright Sean Kelly 2005 - 2009.@licenseDistributed under the Boost Software License 1.0. (See accompanying file LICENSE)@authorsSean Kelly, Alex Rønne Petersen@standardsISO/IEC 9899:1999 (E)
errno
:
(alias constant) eh_channel.EPIPE = int core.stdc.errno.EPIPE = 32
EPIPE
;
import
(package) std
std
.
(module) std.stdio
Category Symbols
File handles _popen File isFileHandle openNetwork stderr stdin stdout
Reading chunks lines readf readfln readln
Writing toFile write writef writefln writeln
Misc KeepTerminator LockType StdioException

Standard I/O functions that extend core.stdc.stdio. core.stdc.stdio is publically imported when importing std.stdio.

There are three layers of I/O:

  1. The lowest layer is the operating system layer. The two main schemes are Windows and Posix.

  2. C's stdio.h which unifies the two operating system schemes.

  3. std.stdio, this module, unifies the various stdio.h implementations into a high level package for D programs.

Source

std/stdio.d

@copyrightCopyright The D Language Foundation 2007-.@licenseBoost License 1.0.@authorsWalter Bright, Andrei Alexandrescu, Alex Rønne Petersen
stdio
:
(alias template) eh_channel.writeln = std.stdio.writeln(T...)(T args)

Equivalent to write(args, '\n'). Calling writeln without arguments is valid and just prints a newline to the standard output.

Example

Reads stdin and writes it to stdout with an argument counter.

import std.stdio;

void main()
{
    string line;

    for (size_t count = 0; (line = readln) !is null; count++)
    {
         writeln("Input ", count, ": ", line);
    }
}
@paramargs the items to write to stdout@throwsIn case of an I/O error, throws an StdioException.
writeln
;
import
(package) sparkles
sparkles
.
(module) sparkles.event_horizon

sparkles:event-horizon — the completion-first event loop with a native algebraic-effect layer. This package module re-exports the public surface (SPEC §16); import sparkles.event_horizon`` for the whole API, or a specific module for a narrower dependency.

event_horizon
;
void
void D main()
main
()
{
(struct) sparkles.event_horizon.group.LoopGroup

A running loop group. Non-copyable; owns its worker scheduler(s).

LoopGroup
(local variable) sparkles.event_horizon.group.LoopGroup group
group
;
if (
(struct) sparkles.event_horizon.group.LoopGroup

A running loop group. Non-copyable; owns its worker scheduler(s).

LoopGroup
.
expected.Expected!(void, IoError, NoGcHook) sparkles.event_horizon.group.LoopGroup.start(out sparkles.event_horizon.group.LoopGroup group, in sparkles.event_horizon.group.LoopGroupConfig cfg = LoopGroupConfig(Topology.single, 0u, 256u, Flag.yes, Flag.yes, 256u, Flag.no))

Probes the kernel and starts the group. io_uring probe failure is a hard error (SPEC §3.4 — no epoll fallback).

start
(
(local variable) sparkles.event_horizon.group.LoopGroup group
group
).
bool expected.Expected!(void, sparkles.base.io.errors.IoError, sparkles.base.text.errors.NoGcHook).hasError!()() const pure nothrow @nogc @property @safe

Checks if Expected has error

hasError
)
assert(false, "no completion backend"); scope (exit)
(local variable) sparkles.event_horizon.group.LoopGroup group
group
.
void sparkles.event_horizon.group.LoopGroup.shutdown(core.time.Duration grace = dur(5L)) nothrow @safe

Tears down the group's workers.

shutdown
();
auto
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) run
run
=
(local variable) sparkles.event_horizon.group.LoopGroup group
group
.
expected.Expected!(int, Cause!(IoError), NoGcHook) sparkles.event_horizon.group.LoopGroup.run!int(scope int delegate(ref sparkles.event_horizon.scope_.Scope!(Sched, IoError) root, ref sparkles.event_horizon.capability.Ctx!(RingClock, RingVfs, RingNet, RingProc) env) main) @system

Runs main as the root fiber inside the root scope, handing it the live capability row. All authority originates here. Blocks the calling thread until the root scope joins. The group remains available until explicit shutdown or destruction.

run
((ref
(alias) sparkles.event_horizon.group.RootScope = sparkles.event_horizon.scope_.Scope!(Sched, IoError)

The blessed live scope instantiation handed to the root fiber (SPEC §7.2, §11): a Scope over the ring-backed Sched executor with the IoError channel.

RootScope
(parameter) sparkles.event_horizon.scope_.Scope!(Sched, IoError) root
root
, ref
(alias) sparkles.event_horizon.live.Env = sparkles.event_horizon.capability.Ctx!(RingClock, RingVfs, RingNet, RingProc)

The default live capability row handed to the root fiber (SPEC §11). fs is on every backend: RingVfs needs no ring file operations (SPEC §10.5).

Env
(parameter) sparkles.event_horizon.capability.Ctx!(RingClock, RingVfs, RingNet, RingProc) env
env
) {
ref
(struct) sparkles.event_horizon.sched.Sched

The per-thread fiber scheduler (SPEC §7.2). Owns its tier-A loop; the FIFO ready queue is intrusive (no allocation); completion callbacks enqueue, never resume inline.

Sched
(local variable) sparkles.event_horizon.sched.Sched s
s
=
sparkles.event_horizon.sched.Sched sparkles.event_horizon.sched.currentScheduler() nothrow @nogc ref @trusted

The scheduler driving the calling fiber.

The tier-B verbs already work this way — read, write, accept take no scheduler because a fiber knows which loop resumed it. This exposes the same answer to code that has to name one: waitReadable, capture, anything taking ref Sched.

It exists because a daemon body cannot be handed a scheduler. An application parks background work through its host's spawnDaemon, which takes a plain void delegate() — the host deliberately does not publish the loop, since two of the three targets have none. A fiber that needs the scheduler therefore has to ask at the top, and this is the ask.

By ref, never by pointer. Every consumer wants ref Sched, so handing back a pointer would make each of them dereference one — and a dereference in @safe code is not free, it is a @trusted escape hatch per call site. A ref return plus a ref local (ref Sched s = currentScheduler();) keeps the whole chain @safe. The nullability that a pointer also carried moves to onScheduler, where it reads as the question it always was.

currentScheduler
();
Channel!(int, 2)
(local variable) sparkles.event_horizon.channel.Channel!(int, 2u) items
items
; // capacity 2: the producer parks on the third put
int
(local variable) int produced
produced
;
bool
(local variable) bool attemptingThird
attemptingThird
;
auto
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) outcome
outcome
=
expected.Expected!(int, Cause!(IoError), NoGcHook) eh_channel.main.__lambda_L22_C26.withScope!(sparkles.event_horizon.sched.Sched)(ref sparkles.event_horizon.sched.Sched exec, sparkles.event_horizon.scope_.ScopeOptions opts = ScopeOptions(OnChildFailure.cancelSiblings)) @system

Runs fn(ref Scope) with a fresh child scope (SPEC §8.1). The calling fiber counts as a member for cancellation targeting (a deadline or cancel sweeping the scope interrupts the body's own awaits); the join runs after the body returns, and is itself uncancellable.

Returns Outcome!(T, E) where T is fn's return type: the body's value, or the scope's first cause.

withScope
!((ref sc) {
assert(sc.spawn(() { foreach (i; 1 .. 6) { if (i == 3) attemptingThird = true; assert(!items.put(s, i).hasError); produced = i; } items.close(); })); while (!attemptingThird) s.yieldNow(); assert(produced == 2, "third put must remain pending while full"); auto first = items.take(s); assert(first.hasValue && first.value == 1); while (produced < 3) s.yieldNow(); assert(produced == 3, "one freed slot permits exactly one put"); int sum = 1; int expected = 2; for (;;) { auto next = items.take(s); // parks while empty if (next.hasError) { assert(next.error.code == EPIPE); break; // closed and drained: EPIPE } assert(next.value == expected++); assert(!env.clock.sleep(2.msecs).hasError); // the slow consumer sum += next.value; } assert(expected == 6 && produced == 5); return sum; })(
(local variable) sparkles.event_horizon.sched.Sched s
s
);
assert(
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) outcome
outcome
.
bool expected.Expected!(int, sparkles.event_horizon.cause.Cause!(IoError), sparkles.base.text.errors.NoGcHook).hasValue!()() const pure nothrow @nogc @property @safe

Checks if Expected has value

hasValue
&&
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) outcome
outcome
.
inout(int) expected.Expected!(int, sparkles.event_horizon.cause.Cause!(IoError), sparkles.base.text.errors.NoGcHook).value!()() inout pure nothrow @nogc @property ref @safe

Returns the expected value if there is one.

With default Abort hook, it asserts when there is no value. It calls hook's onAccessEmptyValue otherwise.

It returns T.init when hook doesn't provide onAccessEmptyValue.

value
== 15);
void std.stdio.writeln!(string, int)(string __param_0, int __param_1) @safe

Equivalent to write(args, '\n'). Calling writeln without arguments is valid and just prints a newline to the standard output.

Example

Reads stdin and writes it to stdout with an argument counter.

import std.stdio;

void main()
{
    string line;

    for (size_t count = 0; (line = readln) !is null; count++)
    {
         writeln("Input ", count, ": ", line);
    }
}
@paramargs the items to write to stdout@throwsIn case of an I/O error, throws an StdioException.
writeln
("consumed: ",
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) outcome
outcome
.
inout(int) expected.Expected!(int, sparkles.event_horizon.cause.Cause!(IoError), sparkles.base.text.errors.NoGcHook).value!()() inout pure nothrow @nogc @property ref @safe

Returns the expected value if there is one.

With default Abort hook, it asserts when there is no value. It calls hook's onAccessEmptyValue otherwise.

It returns T.init when hook doesn't provide onAccessEmptyValue.

value
);
return 0; }); assert(
(local variable) expected.Expected!(int, Cause!(IoError), NoGcHook) run
run
.
bool expected.Expected!(int, sparkles.event_horizon.cause.Cause!(IoError), sparkles.base.text.errors.NoGcHook).hasValue!()() const pure nothrow @nogc @property @safe

Checks if Expected has value

hasValue
);
}