ReadyToRunQueryResult
Namespace: Dotsider.Core.Analysis.Models
Assembly: Dotsider.Core.dll
The result of a ReadyToRunCorrelationQuery: an Outcome with exactly the payload that outcome carries — a Report when resolved, a candidate list when ambiguous, a Message explaining a miss or an unavailable image.
public sealed record ReadyToRunQueryResult : IEquatable<ReadyToRunQueryResult>Inheritance
Section titled “Inheritance”Object → ReadyToRunQueryResult
Implements
Section titled “Implements”Constructors
Section titled “Constructors”ReadyToRunQueryResult(ReadyToRunQueryOutcome, ReadyToRunMethodReport?, IReadOnlyList<CorrelationCandidate>, string?)
Section titled “ReadyToRunQueryResult(ReadyToRunQueryOutcome, ReadyToRunMethodReport?, IReadOnlyList<CorrelationCandidate>, string?)”The result of a ReadyToRunCorrelationQuery: an Outcome with exactly the payload that outcome carries — a Report when resolved, a candidate list when ambiguous, a Message explaining a miss or an unavailable image.
Parameters:
Outcome(ReadyToRunQueryOutcome): How the query resolved.Report(ReadyToRunMethodReport): The resolved correlation, or null unless Outcome is Resolved.Candidates(IReadOnlyList<CorrelationCandidate>): The ambiguous matches, empty unless Outcome is Ambiguous.Message(String): A human-readable explanation for a non-resolved outcome, or null when resolved.
public ReadyToRunQueryResult(ReadyToRunQueryOutcome Outcome, ReadyToRunMethodReport? Report, IReadOnlyList<CorrelationCandidate> Candidates, string? Message)Properties
Section titled “Properties”Candidates
Section titled “Candidates”The ambiguous matches, empty unless Outcome is Ambiguous.
Returns: IReadOnlyList<CorrelationCandidate>
public IReadOnlyList<CorrelationCandidate> Candidates { get; init; }Message
Section titled “Message”A human-readable explanation for a non-resolved outcome, or null when resolved.
Returns: String
public string? Message { get; init; }Outcome
Section titled “Outcome”How the query resolved.
Returns: ReadyToRunQueryOutcome
public ReadyToRunQueryOutcome Outcome { get; init; }Report
Section titled “Report”The resolved correlation, or null unless Outcome is Resolved.
Returns: ReadyToRunMethodReport
public ReadyToRunMethodReport? Report { get; init; }Methods
Section titled “Methods”Ambiguous(IReadOnlyList<CorrelationCandidate>, string)
Section titled “Ambiguous(IReadOnlyList<CorrelationCandidate>, string)”Creates an ambiguous result listing every matched candidate.
Parameters:
candidates(IReadOnlyList<CorrelationCandidate>): The matched candidates.message(String): A summary of the ambiguity.
Returns: ReadyToRunQueryResult
public static ReadyToRunQueryResult Ambiguous(IReadOnlyList<CorrelationCandidate> candidates, string message)Deconstruct(out ReadyToRunQueryOutcome, out ReadyToRunMethodReport?, out IReadOnlyList<CorrelationCandidate>, out string?)
Section titled “Deconstruct(out ReadyToRunQueryOutcome, out ReadyToRunMethodReport?, out IReadOnlyList<CorrelationCandidate>, out string?)”Parameters:
Outcome(ReadyToRunQueryOutcome)Report(ReadyToRunMethodReport)Candidates(IReadOnlyList<CorrelationCandidate>)Message(String)
public void Deconstruct(out ReadyToRunQueryOutcome Outcome, out ReadyToRunMethodReport? Report, out IReadOnlyList<CorrelationCandidate> Candidates, out string? Message)Equals(object?)
Section titled “Equals(object?)”Parameters:
obj(Object)
Returns: Boolean
public override bool Equals(object? obj)Equals(ReadyToRunQueryResult?)
Section titled “Equals(ReadyToRunQueryResult?)”Parameters:
other(ReadyToRunQueryResult)
Returns: Boolean
public bool Equals(ReadyToRunQueryResult? other)GetHashCode()
Section titled “GetHashCode()”Returns: Int32
public override int GetHashCode()NotFound(string)
Section titled “NotFound(string)”Creates a not-found result explaining the miss.
Parameters:
message(String): Why nothing matched.
Returns: ReadyToRunQueryResult
public static ReadyToRunQueryResult NotFound(string message)Resolved(ReadyToRunMethodReport)
Section titled “Resolved(ReadyToRunMethodReport)”Creates a resolved result carrying the report.
Parameters:
report(ReadyToRunMethodReport): The resolved correlation payload.
Returns: ReadyToRunQueryResult
public static ReadyToRunQueryResult Resolved(ReadyToRunMethodReport report)ToString()
Section titled “ToString()”Returns: String
public override string ToString()Unavailable(string)
Section titled “Unavailable(string)”Creates an unavailable result explaining why correlation could not run.
Parameters:
message(String): Why the image is not usable.
Returns: ReadyToRunQueryResult
public static ReadyToRunQueryResult Unavailable(string message)Members
Section titled “Members”operator !=(ReadyToRunQueryResult?, ReadyToRunQueryResult?)
Section titled “operator !=(ReadyToRunQueryResult?, ReadyToRunQueryResult?)”Parameters:
left(ReadyToRunQueryResult)right(ReadyToRunQueryResult)
Returns: Boolean
public static bool operator !=(ReadyToRunQueryResult? left, ReadyToRunQueryResult? right)operator ==(ReadyToRunQueryResult?, ReadyToRunQueryResult?)
Section titled “operator ==(ReadyToRunQueryResult?, ReadyToRunQueryResult?)”Parameters:
left(ReadyToRunQueryResult)right(ReadyToRunQueryResult)
Returns: Boolean
public static bool operator ==(ReadyToRunQueryResult? left, ReadyToRunQueryResult? right)