Class HelpSearchHit

Namespace

Kuestenlogik.Bowire.Help

Assembly

Kuestenlogik.Bowire.dll

One result from Search(string, int). Carries an excerpt so the result list can show context without a follow-up topic-fetch per hit. The score is opaque to the workbench — only the order matters — but provider implementations may stabilise on 0..1 or 0..100 ranges as a future convention.

public sealed record HelpSearchHit : IEquatable<HelpSearchHit>

Inheritance

object

HelpSearchHit

Implements

IEquatable<HelpSearchHit>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

HelpSearchHit(string, string, string, double)

One result from Search(string, int). Carries an excerpt so the result list can show context without a follow-up topic-fetch per hit. The score is opaque to the workbench — only the order matters — but provider implementations may stabilise on 0..1 or 0..100 ranges as a future convention.

public HelpSearchHit(string Id, string Title, string Excerpt, double Score)

Parameters

Id string

Title string

Excerpt string

Score double

Properties

Excerpt

public string Excerpt { get; init; }

Property Value

string

Id

public string Id { get; init; }

Property Value

string

Score

public double Score { get; init; }

Property Value

double

Title

public string Title { get; init; }

Property Value

string

Methods

Deconstruct(out string, out string, out string, out double)

public void Deconstruct(out string Id, out string Title, out string Excerpt, out double Score)

Parameters

Id string

Title string

Excerpt string

Score double

Equals(HelpSearchHit?)

public bool Equals(HelpSearchHit? other)

Parameters

other HelpSearchHit

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HelpSearchHit?, HelpSearchHit?)

public static bool operator ==(HelpSearchHit? left, HelpSearchHit? right)

Parameters

left HelpSearchHit

right HelpSearchHit

Returns

bool

operator !=(HelpSearchHit?, HelpSearchHit?)

public static bool operator !=(HelpSearchHit? left, HelpSearchHit? right)

Parameters

left HelpSearchHit

right HelpSearchHit

Returns

bool