Struct Params

pub struct Params { /* private fields */ }

How to specify API parameters

API parameters can be specified in a number of different ways. All the functions are typed to accept Into<Params>, so as long as it can be converted into Params.

let _: Params = HashMap::from([("action", "query"), ("titles", "Main Page")]).into();
let _: Params = (&HashMap::from([("action", "query"), ("titles", "Main Page")])).into();
let _: Params = BTreeMap::from([("action", "query"), ("titles", "Main Page")]).into();
let _: Params = [("action", "query"), ("titles", "Main Page")].into();
let _: Params = vec![("action", "query"), ("titles", "Main Page")].into();

See the various From implementations below for a complete list.

Implementations

impl Params

pub fn as_map(&self) -> &HashMap<String, String>

Get the parameters as a HashMap

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Params

Returns the “default value” for a type.

impl<P: Display, Q: Display> From<&[(P, Q)]> for Params

fn from(params: &[(P, Q)]) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display, const LENGTH: usize> From<&[(P, Q); LENGTH]> for Params

fn from(params: &[(P, Q); LENGTH]) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<&BTreeMap<P, Q>> for Params

fn from(params: &BTreeMap<P, Q>) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<&HashMap<P, Q>> for Params

fn from(params: &HashMap<P, Q>) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<&Vec<(P, Q)>> for Params

fn from(params: &Vec<(P, Q)>) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display, const LENGTH: usize> From<[(P, Q); LENGTH]> for Params

fn from(params: [(P, Q); LENGTH]) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<BTreeMap<P, Q>> for Params

fn from(params: BTreeMap<P, Q>) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<HashMap<P, Q>> for Params

fn from(params: HashMap<P, Q>) -> Self

Converts to this type from the input type.

impl<P: Display, Q: Display> From<Vec<(P, Q)>> for Params

fn from(params: Vec<(P, Q)>) -> Self

Converts to this type from the input type.

impl<'a, P: Display, Q: Display> FromIterator<&'a (P, Q)> for Params

fn from_iter<T: IntoIterator<Item = &'a (P, Q)>>(iter: T) -> Self

Creates a value from an iterator.

impl<P: Display, Q: Display> FromIterator<(P, Q)> for Params

fn from_iter<T: IntoIterator<Item = (P, Q)>>(iter: T) -> Self

Creates a value from an iterator.