Struct 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 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§

§

impl Freeze for QueryAllUgc

§

impl !RefUnwindSafe for QueryAllUgc

§

impl Send for QueryAllUgc

§

impl Sync for QueryAllUgc

§

impl Unpin for QueryAllUgc

§

impl !UnwindSafe for QueryAllUgc

Blanket Implementations§

Source §

impl<T> Any for T
where 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) -> Dst
where T: Cast<Dst>,

Casts the value.

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where 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 Dst
where 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 Dst
where Src: CheckedCast<Dst>,

Source §

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

Casts the value.

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

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 for T
where 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 Dst
where 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) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

Source §

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

Source §

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

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 for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<T> UnwrappedAs for T

Source §

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

Casts the value.

Source §

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

Source §

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

§

impl<T> WithSubscriber for T

§

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

§

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) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

Source §

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

Source §

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.

Struct QueryAllUgcCopy item path

§Example

Implementations§

impl QueryAllUgc

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

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

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

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

pub fn match_any_tags(self) -> Self

pub fn match_all_tags(self) -> Self

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

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

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

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

pub fn return_long_description(self) -> Self

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

Trait Implementations§

impl Clone for QueryAllUgc

fn clone(&self) -> QueryAllUgc

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

impl Debug for QueryAllUgc

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

Auto Trait Implementations§

impl Freeze for QueryAllUgc

impl !RefUnwindSafe for QueryAllUgc

impl Send for QueryAllUgc

impl Sync for QueryAllUgc

impl Unpin for QueryAllUgc

impl !UnwindSafe for QueryAllUgc

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> Az for T

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

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

fn borrow(&self) -> &T

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

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

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

fn cast_from(src: Src) -> Dst

impl<T> CheckedAs for T

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

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> OverflowingAs for T

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

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

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

impl<T> SaturatingAs for T

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

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

fn saturating_cast_from(src: Src) -> Dst

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> UnwrappedAs for T

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

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

fn unwrapped_cast_from(src: Src) -> Dst

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> WrappingAs for T

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

Struct QueryAllUgc

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

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

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

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

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

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

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

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

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

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

impl<T> ToOwned for T
where T: Clone,

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

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

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

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

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

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

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