ReplProgressEvent
Semantic progress event.
- Kind:
Class - Namespace: Repl.Interaction
- Assembly:
Repl.Core - Source: src/Repl.Core/Interaction/ReplProgressEvent.cs
Signature
Section titled “Signature”public sealed record ReplProgressEvent : ReplInteractionEvent, IEquatable<ReplInteractionEvent>, IEquatable<ReplProgressEvent>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<ReplInteractionEvent>IEquatable<ReplProgressEvent>
Constructors
Section titled “Constructors”ReplProgressEvent(string, double?, int?, int?, string?, ReplProgressState, string?)
Section titled “ReplProgressEvent(string, double?, int?, int?, string?, ReplProgressState, string?)”Semantic progress event.
public ReplProgressEvent(string Label, double? Percent = null, int? Current = null, int? Total = null, string? Unit = null, ReplProgressState State = ReplProgressState.Normal, string? Details = null)Parameters
Section titled “Parameters”Label(string)Percent(double?)Current(int?)Total(int?)Unit(string)State(ReplProgressState)Details(string)
Methods
Section titled “Methods”ResolvePercent()
Section titled “ResolvePercent()”Computes a percentage when not provided explicitly and current/total are available.
public double? ResolvePercent()Returns
Section titled “Returns”double?
Properties
Section titled “Properties”Current
Section titled “Current”public int? Current { get; init; }Returns
Section titled “Returns”int?
Details
Section titled “Details”public string? Details { get; init; }Returns
Section titled “Returns”public string Label { get; init; }Returns
Section titled “Returns”Percent
Section titled “Percent”public double? Percent { get; init; }Returns
Section titled “Returns”double?
public ReplProgressState State { get; init; }Returns
Section titled “Returns”public int? Total { get; init; }Returns
Section titled “Returns”int?
public string? Unit { get; init; }