Logo ProcessKit API Reference

OverflowMode Type

What to drop when a bounded output buffer is full.

Union cases

Union case Description

DropNewest

Full Usage: DropNewest

"Head" semantics: keep what is already buffered and discard new lines.

DropOldest

Full Usage: DropOldest

Ring-buffer / "tail" semantics: discard the oldest retained line so the most recent output survives.

Error

Full Usage: Error

Fail-loud ceiling: once the cap would be exceeded the run errors with `ProcessError.OutputTooLarge` rather than silently dropping. Output exactly equal to a configured limit is retained; the error is raised on the next line/byte that would push past it, not on reaching the limit exactly. The pipe is still drained (the child never blocks); excess lines are counted but not retained. With no cap set (`MaxLines = None` and `MaxBytes = None`) there is no ceiling to cross, so `Error` behaves like the other overflow modes on an unbounded buffer: it retains everything and never trips `OutputTooLarge`.

Instance members

Instance member Description

this.IsDropNewest

Full Usage: this.IsDropNewest

Returns: bool
Returns: bool

this.IsDropOldest

Full Usage: this.IsDropOldest

Returns: bool
Returns: bool

this.IsError

Full Usage: this.IsError

Returns: bool
Returns: bool

Type something to start searching.