Struct tokio_ddmw::clntif::Params

pub struct Params { /* fields omitted */ }

Key/value parameters storage.

Implementations

impl Params

pub fn new() -> Params

Create a new empty parameters object.

pub fn clear(&mut self)

Reset all the key/values.

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

pub fn add_param<T, U>(&mut self, key: T, value: U) where
    T: ToString,
    U: ToString, 

Add a parameter to the parameter.

pub fn add_str<T, U>(&mut self, key: T, value: U) where
    T: ToString,
    U: ToString, 

Add a string parameter to the parameter.

pub fn get_param<T>(&self, key: &str) -> Result<T, Error> where
    T: FromStr, 

Get a parameter and convert it to a requested type.

pub fn get_str(&self, key: &str) -> Option<&str>

Get string representation of a value for a requested key. Returns None if the key is not found in the inner storage. Returns Some(&str) otherwise.

pub fn get_int<T>(&self, key: &str) -> Result<T, Error> where
    T: FromStr, 

Get a parameter and convert it to an integer type. The logic of this method is identical to get_param().

use blather::Params;
fn main() {
  let mut params = Params::new();
  params.add_param("Num", 7);
  assert_eq!(params.get_int::<usize>("Num").unwrap(), 7);
}

This method should really have some integer trait bound, but it doesn't seem to exist in the standard library.

This method exists primarily to achive some sort of parity with a corresponding C++ library.

pub fn calc_buf_size(&self) -> usize

Calculate the size of the buffer in serialized form. Each entry will be a newline terminated utf-8 line. Last line will be a single newline character.

pub fn serialize(&self) -> Result<Vec<u8>, Error>

pub fn encoder_write(&self, buf: &mut BytesMut) -> Result<(), Error>

Write the Params to a buffer.

pub fn into_inner(self) -> HashMap<String, String, RandomState>

Consume the Params buffer and return the internal parameters 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<(), Error>

Formats the value using the given formatter.

impl Default for Params

fn default() -> Params

Returns the "default value" for a type.

impl Display for Params

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

Formats the value using the given formatter.

impl<'_> Encoder<&'_ Params> for Codec

type Error = Error

The type of encoding errors.

fn encode(&mut self, params: &Params, buf: &mut BytesMut) -> Result<(), Error>

Encodes a frame into the buffer provided.

impl From<HashMap<String, String, RandomState>> for Params

fn from(hm: HashMap<String, String, RandomState>) -> Params

Performs the conversion.

impl From<Params> for Telegram

fn from(params: Params) -> Telegram

Performs the conversion.