Struct steamworks::ugc::QueryAllUgc

source · 
pub struct QueryAllUgc { /* private fields */ }
Expand description

A builder for configuring a request to query all UGC.

See https://partner.steamgames.com/doc/features/workshop/implementation#QueryContent for an overview of how querying UGC content works in Steamworks.

Example

use steamworks::ugc::{MatchingUgcType, QueryType};

let ugc = client
    .query_all_ugc(MatchingUgcType::ItemsReadyToUse)
    .query_type(QueryType::RankedByPublicationDate)
    .required_tag("Sprint")
    .run();

Implementations§

source§

impl QueryAllUgc

source

pub fn new(client: Client, matching_ugc_type: MatchingUgcType) -> Self

source

pub fn query_type(self, query_type: QueryType) -> Self

Sets the eQueryType argument of CreateQueryAllUGCRequest

Defaults to RankedByPublicationDate

source

pub fn creator_app_id(self, app_id: AppId) -> Self

Sets the nCreatorAppID argument of CreateQueryAllUGCRequest

Defaults to the current application’s App ID.

source

pub fn consumer_app_id(self, app_id: AppId) -> Self

Sets the nConsumerAppID argument of CreateQueryAllUGCRequest

Defaults to the current application’s App ID.

source

pub fn match_any_tags(self) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#SetMatchAnyTag

source

pub fn match_all_tags(self) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#SetMatchAnyTag

source

pub fn required_tag(self, tag: impl Into<Vec<u8>>) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#AddRequiredTag

source

pub fn required_tags<T: Into<Vec<u8>>>( self, tags: impl IntoIterator<Item = T> ) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#AddRequiredTag

source

pub fn excluded_tag(self, tag: impl Into<Vec<u8>>) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#AddExcludedTag

source

pub fn excluded_tags<T: Into<Vec<u8>>>( self, tags: impl IntoIterator<Item = T> ) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#AddExcludedTag

source

pub fn return_long_description(self) -> Self

https://partner.steamgames.com/doc/api/ISteamUGC#SetReturnLongDescription

source

pub fn run( self ) -> impl Stream<Item = Result<UgcDetails, QueryAllUgcError>> + Send

Executes the query.

Trait Implementations§

source§

impl Clone for QueryAllUgc

source§

fn clone(&self) -> QueryAllUgc

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for QueryAllUgc

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dstwhere T: Cast<Dst>,

Casts the value.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dstwhere Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dstwhere T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dstwhere T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dstwhere T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.