Struct SearchBuilder 

pub struct SearchBuilder<T = ()> { /* private fields */ }

A builder for building the URL with the indicated parameters This struct works with TypeState Programming so the SearchBuilder::build_url() method can’t be called unless search_type is set.

The facets field works as a conjunction (AND) of disjunctions (OR):

Implementations

impl SearchBuilder<()>

pub fn new() -> SearchBuilder<()>

impl<T> SearchBuilder<T>

pub fn facets(self, facets: impl Into<FacetsConjunction>) -> Self

Sets the facets.

pub fn game_versions<E>(self, versions: impl IntoIterator<Item = E>) -> Self

where E: ToString,

Sets the game versions filter for the project version search.

Parameters

• versions: A type that can be iterated and its items implements ToString.

Returns

Returns an updated instance of the SearchBuilder with the specified game versions filter applied.

Example

use rrhodium::*;
let builder = SearchBuilder::new()
    .search_type(SearchType::ProjectVersion {id: "example_id".to_owned(), loaders:
    Some(vec!["fabric".to_string()])})
    .game_versions(["1.16.5", "1.17.1"])
    .build_url();

Restrictions

This method is only available when the search type is ProjectVersion. Attempting to call this method for other search types will do nothing.

Panics

This method does not panic.

Notes

• The game_versions parameter allows you to filter results to only include project versions compatible with the specified game versions.
• Ensure that you are using this method within the ProjectVersion search context, as it is specifically designed for filtering versions based on game compatibility.

pub fn add_game_version(self, version: impl ToString) -> Self

Adds a single game version to the game versions filter for the project version search.

This method allows you to append a game version to the existing filter criteria in the SearchBuilder. The version is added to the vector of game versions that will be used to filter the results of the search.

Parameters

• version: Whatever type that can be transformed into a String.

Returns

Returns an updated instance of the SearchBuilder with the specified game version added to the filter criteria.

Example

use rrhodium::{SearchType, SearchBuilder};
let builder = SearchBuilder::new()
    .search_type(SearchType::ProjectVersion {id: "example_id".to_string(), loaders: Some(vec!["fabric".to_string()])})
    .add_game_version("1.16.5")
    .add_game_version("1.17.1")
    .build_url();

Restrictions

This method only has an effect when the search type is ProjectVersion. If used with a different search type, it will have no impact on the search builder and will silently ignore the call.

Panics

This method does not panic.

Errors

This method does not return errors.

Notes

• Ensure that this method is called within the ProjectVersion search context, as it is specifically designed for filtering project versions based on game compatibility.
• If used outside the ProjectVersion context, the method will not modify the builder and will effectively do nothing.

pub fn search_type(self, search_type: SearchType) -> SearchBuilder<SearchType>

impl SearchBuilder<SearchType>

pub fn build_url(self) -> String

Generates the URL based on the SearchBuilder object.

This method constructs a URL for the Modrinth API using various parameters from the SearchBuilder struct. It supports multiple search types and query parameters, and it constructs the URL accordingly.

Returns

A String representing the constructed URL.

Examples

use rrhodium::*;
    let search_builder: String = SearchBuilder::new()
    .search_type(QueryBuilder::new().limit(10).offset(5).build())
    .build_url();
assert_eq!("https://api.modrinth.com/v2/search?limit=10&offset=5", &search_builder);

Trait Implementations

impl<T: Default> Default for SearchBuilder<T>

fn default() -> SearchBuilder<T>

Returns the “default value” for a type.