Struct roboat::catalog::catalog_types::AvatarSearchQuery

pub struct AvatarSearchQuery {

    pub category: Option<Category>,
    pub creator_name: Option<String>,
    pub creator_id: Option<u64>,
    pub creator_type: Option<CreatorType>,
    pub query_genres: Vec<QueryGenre>,
    pub keyword: Option<String>,
    pub sort_aggregation: Option<SortAggregation>,
    pub sort_type: Option<SortType>,
    pub subcategory: Option<Subcategory>,
    pub min_price: Option<u32>,
    pub max_price: Option<u32>,
    pub limit: Option<CatalogQueryLimit>,
    pub sales_type_filter: Option<SalesTypeFilter>,
}

Information comes directly from here https://create.roblox.com/docs/studio/catalog-api#marketplace-api.

Fields

category: Option<Category>

Category must be filled to query more than one page.

creator_name: Option<String>

Search by creator name. If creator_type is not provided, search is for users only.

creator_id: Option<u64>

Corresponds to a user id or group id depending on the creator type. Must be filled if creator_type is filled.

creator_type: Option<CreatorType>

Must be filled if creator_id is filled.

query_genres: Vec<QueryGenre>

The genres of the item; keep in mind QueryGenre is different from Genre.

keyword: Option<String>

The keyword to search for.

sort_aggregation: Option<SortAggregation>

The sort aggregation is used to sort the results by a specific metric. View SortAggregation for more information.

sort_type: Option<SortType>

The sort type is used to sort the results in a specific order. View SortType for more information.

subcategory: Option<Subcategory>

Subcategory must be filled to query more than one page.

min_price: Option<u32>

The minimum price for each asset.

This is a u32 because large numbers are almost always not needed and cause the endpoint to return an error. More information can be found here: https://github.com/Chloe-Woahie/roboat/pull/61.

max_price: Option<u32>

The maximum price for each asset.

This is a u32 because large numbers are almost always not needed and cause the endpoint to return an error. More information can be found here: https://github.com/Chloe-Woahie/roboat/pull/61.

limit: Option<CatalogQueryLimit>

The maximum assets Roblox should return per page. View CatalogQueryLimit for more information.

sales_type_filter: Option<SalesTypeFilter>

Sort between different sale types of assets. View SalesTypeFilter for more information.

Implementations

impl AvatarSearchQuery

pub fn to_url(&self) -> String

Converts the query into a url.

Trait Implementations

impl Clone for AvatarSearchQuery

fn clone(&self) -> AvatarSearchQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AvatarSearchQuery

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

Formats the value using the given formatter.

impl Default for AvatarSearchQuery

fn default() -> AvatarSearchQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AvatarSearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AvatarSearchQuery

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AvatarSearchQuery

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for AvatarSearchQuery

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AvatarSearchQuery

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Serialize for AvatarSearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AvatarSearchQuery

impl StructuralPartialEq for AvatarSearchQuery