Struct steamworks::QueryResults
source · pub struct QueryResults<'a> { /* private fields */ }
Expand description
Query results
Implementations§
source§impl<'a> QueryResults<'a>
impl<'a> QueryResults<'a>
sourcepub fn was_cached(&self) -> bool
pub fn was_cached(&self) -> bool
Were these results retreived from a cache?
sourcepub fn total_results(&self) -> u32
pub fn total_results(&self) -> u32
Gets the total number of results in this query, not just the current page
sourcepub fn returned_results(&self) -> u32
pub fn returned_results(&self) -> u32
Gets the number of results in this page.
sourcepub fn preview_url(&self, index: u32) -> Option<String>
pub fn preview_url(&self, index: u32) -> Option<String>
Gets the preview URL of the published file at the specified index.
sourcepub fn statistic(&self, index: u32, stat_type: UGCStatisticType) -> Option<u64>
pub fn statistic(&self, index: u32, stat_type: UGCStatisticType) -> Option<u64>
Gets a UGC statistic about the published file at the specified index.
sourcepub fn content_descriptor(&self, index: u32) -> Vec<UGCContentDescriptorID>
pub fn content_descriptor(&self, index: u32) -> Vec<UGCContentDescriptorID>
Gets UGCContentDescriptors of the published file at the specified index.
sourcepub fn get(&self, index: u32) -> Option<QueryResult>
pub fn get(&self, index: u32) -> Option<QueryResult>
Gets a result.
Returns None if index was out of bounds.
sourcepub fn iter<'b>(&'b self) -> impl Iterator<Item = Option<QueryResult>> + 'b
pub fn iter<'b>(&'b self) -> impl Iterator<Item = Option<QueryResult>> + 'b
Returns an iterator that runs over all the fetched results
sourcepub fn get_children(&self, index: u32) -> Option<Vec<PublishedFileId>>
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.
Returns the number of key value tags associated with the item at the specified index.