SizeBudgetReport
Namespace: Dotsider.Core.Analysis.Models
Assembly: Dotsider.Core.dll
The outcome of checking a build against a set of size budgets. The check fails — Passed is false — only when an error-severity budget breached; warning breaches surface through HasWarnings without failing the check.
public sealed record SizeBudgetReport : IEquatable<SizeBudgetReport>Inheritance
Section titled “Inheritance”Object → SizeBudgetReport
Implements
Section titled “Implements”Constructors
Section titled “Constructors”SizeBudgetReport(bool, bool, SizeBasis, long, long, long?, long?, IReadOnlyList<SizeBudgetEvaluation>)
Section titled “SizeBudgetReport(bool, bool, SizeBasis, long, long, long?, long?, IReadOnlyList<SizeBudgetEvaluation>)”The outcome of checking a build against a set of size budgets. The check fails — Passed is false — only when an error-severity budget breached; warning breaches surface through HasWarnings without failing the check.
Parameters:
Passed(Boolean): False when at least one error-severity budget breached.HasWarnings(Boolean): True when at least one warning-severity budget breached.TotalBasis(SizeBasis): What the total figures count: file size when the inputs were binaries, mstat totals otherwise.LeftTotal(Int64): The baseline total on TotalBasis, or 0 when the check ran without a baseline.RightTotal(Int64): The current total on TotalBasis.LeftMstatTotal(Nullable<Int64>): The baseline’s mstat attributable total, surfaced alongside when TotalBasis is file size; null otherwise.RightMstatTotal(Nullable<Int64>): The current build’s mstat attributable total, surfaced alongside when TotalBasis is file size; null otherwise.Evaluations(IReadOnlyList<SizeBudgetEvaluation>): One outcome per budget, in input order.
public SizeBudgetReport(bool Passed, bool HasWarnings, SizeBasis TotalBasis, long LeftTotal, long RightTotal, long? LeftMstatTotal, long? RightMstatTotal, IReadOnlyList<SizeBudgetEvaluation> Evaluations)Properties
Section titled “Properties”Evaluations
Section titled “Evaluations”One outcome per budget, in input order.
Returns: IReadOnlyList<SizeBudgetEvaluation>
public IReadOnlyList<SizeBudgetEvaluation> Evaluations { get; init; }HasDeferred
Section titled “HasDeferred”True when one or more growth limits were deferred because no baseline exists.
Returns: Boolean
public bool HasDeferred { get; init; }HasWarnings
Section titled “HasWarnings”True when at least one warning-severity budget breached.
Returns: Boolean
public bool HasWarnings { get; init; }LeftMstatTotal
Section titled “LeftMstatTotal”The baseline’s mstat attributable total, surfaced alongside when TotalBasis is file size; null otherwise.
Returns: Nullable<Int64>
public long? LeftMstatTotal { get; init; }LeftTotal
Section titled “LeftTotal”The baseline total on TotalBasis, or 0 when the check ran without a baseline.
Returns: Int64
public long LeftTotal { get; init; }Passed
Section titled “Passed”False when at least one error-severity budget breached.
Returns: Boolean
public bool Passed { get; init; }RightMstatTotal
Section titled “RightMstatTotal”The current build’s mstat attributable total, surfaced alongside when TotalBasis is file size; null otherwise.
Returns: Nullable<Int64>
public long? RightMstatTotal { get; init; }RightTotal
Section titled “RightTotal”The current total on TotalBasis.
Returns: Int64
public long RightTotal { get; init; }TotalBasis
Section titled “TotalBasis”What the total figures count: file size when the inputs were binaries, mstat totals otherwise.
Returns: SizeBasis
public SizeBasis TotalBasis { get; init; }Methods
Section titled “Methods”Deconstruct(out bool, out bool, out SizeBasis, out long, out long, out long?, out long?, out IReadOnlyList<SizeBudgetEvaluation>)
Section titled “Deconstruct(out bool, out bool, out SizeBasis, out long, out long, out long?, out long?, out IReadOnlyList<SizeBudgetEvaluation>)”Parameters:
Passed(Boolean)HasWarnings(Boolean)TotalBasis(SizeBasis)LeftTotal(Int64)RightTotal(Int64)LeftMstatTotal(Nullable<Int64>)RightMstatTotal(Nullable<Int64>)Evaluations(IReadOnlyList<SizeBudgetEvaluation>)
public void Deconstruct(out bool Passed, out bool HasWarnings, out SizeBasis TotalBasis, out long LeftTotal, out long RightTotal, out long? LeftMstatTotal, out long? RightMstatTotal, out IReadOnlyList<SizeBudgetEvaluation> Evaluations)Equals(object?)
Section titled “Equals(object?)”Parameters:
obj(Object)
Returns: Boolean
public override bool Equals(object? obj)Equals(SizeBudgetReport?)
Section titled “Equals(SizeBudgetReport?)”Parameters:
other(SizeBudgetReport)
Returns: Boolean
public bool Equals(SizeBudgetReport? other)GetHashCode()
Section titled “GetHashCode()”Returns: Int32
public override int GetHashCode()ToString()
Section titled “ToString()”Returns: String
public override string ToString()Members
Section titled “Members”operator !=(SizeBudgetReport?, SizeBudgetReport?)
Section titled “operator !=(SizeBudgetReport?, SizeBudgetReport?)”Parameters:
left(SizeBudgetReport)right(SizeBudgetReport)
Returns: Boolean
public static bool operator !=(SizeBudgetReport? left, SizeBudgetReport? right)operator ==(SizeBudgetReport?, SizeBudgetReport?)
Section titled “operator ==(SizeBudgetReport?, SizeBudgetReport?)”Parameters:
left(SizeBudgetReport)right(SizeBudgetReport)
Returns: Boolean
public static bool operator ==(SizeBudgetReport? left, SizeBudgetReport? right)