Struct cranky::ResultRecord

pub struct ResultRecord {
    pub qid: Qid,
    pub docid: Docid,
    pub rank: Rank,
    pub score: Score,
    pub iter: Iter,
    pub run: Option<Run>,
    // some fields omitted
}

Result record.

Examples

The separator could be any number of whitespaces.

let record_line = "030  Q0\tZF08-175-870  0 \t 4238   prise1";
let record: ResultRecord = Record::parse_record(record_line, None)?;

You can use StringIdFactory to reuse string-based IDs.

let mut id_factory = StringIdFactory::new();
let record_line = "030  Q0\tZF08-175-870  0 \t 4238   prise1";
let record: ResultRecord = Record::parse_record(record_line, Some(&mut id_factory))?;

When formating to a string, all separators are tabs:

assert_eq!(
    &format!("{}", record),
    "030\tQ0\tZF08-175-870\t0\t4238\tprise1"
);

Fields

qid: Qid

Query TREC ID.

docid: Docid

Document TREC ID.

rank: Rank

Rank of the document in query result set. The lower the number, the higher the document is ranked.

score: Score

Score of the document in query result set. The higher the number, the higher the document is ranked.

iter: Iter

Iteration.

run: Option<Run>

Run ID.

Trait Implementations

impl Record for ResultRecord

fn parse_record(
    record_line: &str,
    id_factory: Option<&mut StringIdFactory>
) -> Result<Self, Error>

Parses record from a line of text. record_factory is optionally used for reusing string-based IDs; in case of its absense, all strings will be copied to the record.

impl Eq for ResultRecord

impl PartialOrd<ResultRecord> for ResultRecord

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<ResultRecord> for ResultRecord

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for ResultRecord

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Debug for ResultRecord

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for ResultRecord

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.