Struct SearchDocument
Represents a searchable document that has been indexed.
Syntax
public struct SearchDocument : IEquatable<SearchDocument>, IComparable<SearchDocument>
Constructors
SearchDocument(Int32, String, String, Int32)
Create a new SearchDocument
Declaration
public SearchDocument(int index, string id, string path = null, int score = 2147483647)
Parameters
SearchDocument(SearchDocument, Int32)
Declaration
public SearchDocument(SearchDocument doc, int score)
Parameters
SearchDocument(SearchDocument, String)
Declaration
public SearchDocument(SearchDocument doc, string path)
Parameters
Fields
id
Declaration
public readonly string id
Field Value
index
Declaration
public readonly int index
Field Value
score
Declaration
public readonly int score
Field Value
Properties
path
Declaration
public string path { get; }
Property Value
valid
Declaration
public bool valid { get; }
Property Value
Methods
CompareTo(SearchDocument)
Declaration
public int CompareTo(SearchDocument other)
Parameters
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
| Type |
Name |
Description |
| Object |
other |
|
Returns
Overrides
Equals(SearchDocument)
Declaration
public bool Equals(SearchDocument other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
ToString()
Returns the document id string.
Declaration
public override string ToString()
Returns
| Type |
Description |
| String |
Returns a string representation of the Document.
|
Overrides
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.