Skip to main content

RequestParameter

Struct RequestParameter 

Source
pub struct RequestParameter {
    pub name: Cow<'static, str>,
    pub value: Option<Value>,
    pub input_files: Option<Vec<InputFileRef>>,
}
Expand description

A single named parameter sent to the Telegram Bot API.

§Relationship to Python source

Python attributeRust field
nameRequestParameter::name
valueRequestParameter::value
input_filesRequestParameter::input_files

The json_value and multipart_data Python properties are implemented as methods here: RequestParameter::json_value and RequestParameter::multipart_data.

Fields§

§name: Cow<'static, str>

The API parameter name, e.g. "chat_id" or "photo".

§value: Option<Value>

The JSON-serialisable value. None is used when the parameter consists solely of a file that must be uploaded without an attach URI (the Python branch return None, [value]).

§input_files: Option<Vec<InputFileRef>>

Files to upload together with this parameter.

Implementations§

Source§

impl RequestParameter

Source

pub fn new(name: impl Into<Cow<'static, str>>, value: impl Into<Value>) -> Self

Construct a plain (non-file) parameter.

use rust_tg_bot_raw::request::request_parameter::RequestParameter;
use serde_json::json;

let p = RequestParameter::new("chat_id", json!(12345));
assert_eq!(p.json_value().unwrap(), "12345");
Source

pub fn with_files( name: impl Into<Cow<'static, str>>, value: impl Into<Value>, files: Vec<InputFileRef>, ) -> Self

Construct a parameter that carries attached files alongside a JSON value.

Source

pub fn file_only(name: impl Into<Cow<'static, str>>, file: InputFileRef) -> Self

Construct a file-only parameter where the JSON value is absent (the Python return None, [value] case).

Source

pub fn json_value(&self) -> Option<String>

The JSON-encoded string representation of Self::value, or None when the value is absent.

Mirrors RequestParameter.json_value in Python:

  • str values are returned as-is (without extra JSON quotes).
  • All other values are serialised with serde_json::to_string.
use rust_tg_bot_raw::request::request_parameter::RequestParameter;
use serde_json::json;

let string_param = RequestParameter::new("text", json!("hello"));
// String values are returned verbatim, not double-encoded.
assert_eq!(string_param.json_value().unwrap(), "hello");

let int_param = RequestParameter::new("count", json!(42));
assert_eq!(int_param.json_value().unwrap(), "42");

let bool_param = RequestParameter::new("enabled", json!(true));
assert_eq!(bool_param.json_value().unwrap(), "true");
Source

pub fn multipart_data(&self) -> Option<Vec<(String, &InputFileRef)>>

Produce the multipart parts contributed by this parameter’s files.

Returns None when there are no attached files.

The returned iterator yields (part_name, file) pairs where part_name is either the file’s attach_name or, when absent, the parameter name. This mirrors the Python dict comprehension:

{(input_file.attach_name or self.name): input_file.field_tuple ...}

Trait Implementations§

Source§

impl Clone for RequestParameter

Source§

fn clone(&self) -> RequestParameter

Returns a duplicate 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 RequestParameter

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 T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
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<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.

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 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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