Class

LogTailOptionsFluent

ConsoleMonster.Live.Tails

Namespace: ConsoleMonster.Live.Tails
Assembly: ConsoleMonster
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of LogTailOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

object
LogTailOptionsFluent

Methods

public static LogTailOptions Capacity(LogTailOptions logTailOptions, int value) #

Sets LogTailOptions.Capacity: Maximum retained history lines (default 1000; minimum 1). Pending source updates are lossless.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value int required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Capacity = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Capacity(value);

public static LogTailOptions Configure(LogTailOptions logTailOptions, Action<LogTailOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
configure System.Action<ConsoleMonster.Live.Tails.LogTailOptions> required: Assignments applied in order.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { WriteLine = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Configure(configured => configured.WriteLine = value);

public static LogTailOptions Count(LogTailOptions logTailOptions, long value) #

Sets LogTailOptions.Count: Source-read iterations; one processes one complete snapshot, zero follows until cancelled or quit.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value long required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Count = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Count(value);

public static LogTailOptions Filter(LogTailOptions logTailOptions, string? value) #

Sets LogTailOptions.Filter: Literal, ordinal case-insensitive substring required in the original line; null or empty accepts all.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value string? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Filter = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Filter(value);

HandleCancelKey 2 overloads

public static LogTailOptions HandleCancelKey(LogTailOptions logTailOptions, bool value) #

Sets LogTailOptions.HandleCancelKey: Whether to handle the console's Ctrl+C signal cooperatively (default true).

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value bool required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { HandleCancelKey = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().HandleCancelKey(value);

public static LogTailOptions HandleCancelKey(LogTailOptions logTailOptions) #

Sets LogTailOptions.HandleCancelKey to true.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance to configure.

Returns

LogTailOptions The same instance.

public static LogTailOptions Highlight(LogTailOptions logTailOptions, string? value) #

Sets LogTailOptions.Highlight: Literal, ordinal case-insensitive substring emphasized in live frames; plain lines stay unchanged.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value string? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Highlight = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Highlight(value);

public static LogTailOptions Input(LogTailOptions logTailOptions, IInputSource? value) #

Sets LogTailOptions.Input: Borrowed input source leased through ConsoleInput, or null for the current target, input override or console.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value ConsoleMonster.Input.IInputSource? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Input = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Input(value);

Live 2 overloads

public static LogTailOptions Live(LogTailOptions logTailOptions, bool value) #

Sets LogTailOptions.Live: Enables the live viewer when the host supports input; false writes literal lines without acquiring input.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value bool required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Live = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Live(value);

public static LogTailOptions Live(LogTailOptions logTailOptions) #

Sets LogTailOptions.Live to true.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance to configure.

Returns

LogTailOptions The same instance.

public static LogTailOptions Mode(LogTailOptions logTailOptions, LiveMode value) #

Sets LogTailOptions.Mode: Live layout, full screen by default. Plain fallback ignores this setting.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value ConsoleMonster.Live.LiveMode required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Mode = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Mode(value);

public static LogTailOptions Output(LogTailOptions logTailOptions, ITerminalOutput? value) #

Sets LogTailOptions.Output: Borrowed live output, or null for the core terminal output. A non-live output selects plain fallback.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value ConsoleMonster.Rendering.ITerminalOutput? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Output = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Output(value);

public static LogTailOptions PollInterval(LogTailOptions logTailOptions, TimeSpan value) #

Sets LogTailOptions.PollInterval: Time between source reads (default 250 milliseconds; positive and at most Int32.MaxValue milliseconds).

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value System.TimeSpan required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { PollInterval = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().PollInterval(value);

public static LogTailOptions Profile(LogTailOptions logTailOptions, TerminalProfile? value) #

Sets LogTailOptions.Profile: Terminal profile override, or null for the current terminal target's profile.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value ConsoleMonster.Capabilities.TerminalProfile? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Profile = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Profile(value);

public static LogTailOptions Theme(LogTailOptions logTailOptions, ITheme? value) #

Sets LogTailOptions.Theme: Theme override, or null for the current terminal target's theme.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value ConsoleMonster.Styling.ITheme? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { Theme = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().Theme(value);

public static LogTailOptions TimestampFormat(LogTailOptions logTailOptions, string? value) #

Sets LogTailOptions.TimestampFormat: Invariant source timestamp format, or null for HH:mm:ss, adding yyyy-MM-dd when retained source dates differ. Applies only to the live view, at every terminal width; plain original lines and source metadata are unchanged.

Parameters

logTailOptions ConsoleMonster.Live.Tails.LogTailOptions required: The instance.
value string? required: The value.

Returns

LogTailOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Live.Tails.LogTailOptions { TimestampFormat = value };    Ui.Options<global::ConsoleMonster.Live.Tails.LogTailOptions>().TimestampFormat(value);

Inheritance

Methods

Inherited Methods