ResultFlowOptions
Configures Repl result-flow behavior for paging and large result sets.
- Kind:
Class - Namespace: Repl
- Assembly:
Repl.Core - Source: src/Repl.Core/ResultFlow/ResultFlowOptions.cs
Signature
Section titled “Signature”public sealed class ResultFlowOptionsInheritance
Section titled “Inheritance”Methods
Section titled “Methods”ClearPagerRenderers()
Section titled “ClearPagerRenderers()”Removes all custom pager renderers.
public void ClearPagerRenderers()RemovePagerRenderer(ReplPagerMode)
Section titled “RemovePagerRenderer(ReplPagerMode)”Removes the custom pager renderer registered for a mode.
public bool RemovePagerRenderer(ReplPagerMode mode)Parameters
Section titled “Parameters”mode(ReplPagerMode): Pager mode to remove.
Returns
Section titled “Returns”bool - True when a renderer was removed.
UsePagerRenderer(IReplPagerRenderer)
Section titled “UsePagerRenderer(IReplPagerRenderer)”Registers or replaces the pager renderer for its configured mode.
public ResultFlowOptions UsePagerRenderer(IReplPagerRenderer renderer)Parameters
Section titled “Parameters”renderer(IReplPagerRenderer): Renderer to register.
Returns
Section titled “Returns”ResultFlowOptions - This options instance.
Properties
Section titled “Properties”DefaultPageSize
Section titled “DefaultPageSize”Gets or sets the default page size when no terminal-specific hint is available.
public int DefaultPageSize { get; set; }Returns
Section titled “Returns”DefaultPagerMode
Section titled “DefaultPagerMode”Gets or sets the default pager mode for human output.
public ReplPagerMode DefaultPagerMode { get; set; }Returns
Section titled “Returns”MaxBufferedLines
Section titled “MaxBufferedLines”Gets or sets the maximum number of content lines an interactive pager buffers in memory.
public int MaxBufferedLines { get; set; }Returns
Section titled “Returns”MaxPageSize
Section titled “MaxPageSize”Gets or sets the maximum page size a caller can request.
public int MaxPageSize { get; set; }Returns
Section titled “Returns”PagerRenderers
Section titled “PagerRenderers”Gets custom pager renderers keyed by Mode.
public IReadOnlyList<IReplPagerRenderer> PagerRenderers { get; }Returns
Section titled “Returns”IReadOnlyList<IReplPagerRenderer>
ProgrammaticMaxInlineBytes
Section titled “ProgrammaticMaxInlineBytes”Gets or sets the maximum inline payload size for programmatic clients.
public int ProgrammaticMaxInlineBytes { get; set; }Returns
Section titled “Returns”ReservedVisibleRows
Section titled “ReservedVisibleRows”Gets or sets the number of non-data rows reserved in interactive pagers.
public int ReservedVisibleRows { get; set; }