Struct steamworks::QueryResults

pub struct QueryResults<'a> { /* fields omitted */ }

Query results

Implementations

impl<'a> QueryResults<'a>

pub fn was_cached(&self) -> bool

Were these results retreived from a cache?

pub fn total_results(&self) -> u32

Gets the total number of results in this query, not just the current page

pub fn returned_results(&self) -> u32

Gets the number of results in this page.

pub fn preview_url(&self, index: u32) -> Option<String>

Gets the preview URL of the published file at the specified index.

pub fn statistic(&self, index: u32, stat_type: UGCStatisticType) -> Option<u64>

Gets a UGC statistic about the published file at the specified index.

pub fn get(&self, index: u32) -> Option<QueryResult>

Gets a result.

Returns None if index was out of bounds.

pub fn iter<'b>(&'b self) -> impl Iterator<Item = Option<QueryResult>> + 'b

Returns an iterator that runs over all the fetched results

pub fn get_children(&self, index: u32) -> Option<Vec<PublishedFileId>>

Returns the given index’s children as a list of PublishedFileId.

You must call include_children(true) before fetching the query for this to work.

Returns None if the index was out of bounds.

pub fn key_value_tags(&self, index: u32) -> u32

Returns the number of key value tags associated with the item at the specified index.

pub fn get_key_value_tag(
    &self,
    index: u32,
    kv_tag_index: u32
) -> Option<(String, String)>

Gets the key value pair of a specified key value tag associated with the item at the specified index.

pub fn get_metadata(&self, index: u32) -> Option<Vec<u8>>

Gets the developer-set metadata associated with the item at the specified index.

This is returned as a vector of raw bytes.

Trait Implementations

impl<'a> Drop for QueryResults<'a>

fn drop(&mut self)

Executes the destructor for this type.