Struct Params 

pub struct Params { /* private fields */ }

A safe wrapper around NIXL parameters

Implementations

impl Params

pub fn from<I, K, V>(iter: I) -> Result<Self, NixlError>

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Creates a new Params object from an iteratable

Example

use std::collections::HashMap;

let map = HashMap::from([
    ("access_key", "*********"),
    ("secret_key", "*********"),
    ("bucket", "my-bucket"),
]);

let params = Params::from(map.iter().map(|(k, v)| (*k, *v)))?;

pub fn clone(&self) -> Result<Self, NixlError>

Creates a new Params object by copying from another Params

Example

let original_params = agent.get_plugin_params("OBJ")?.1;
let mut modified_params = original_params.clone()?;
modified_params.set("bucket", "my-custom-bucket")?;

pub fn set(&mut self, key: &str, value: &str) -> Result<(), NixlError>

Sets a key-value pair in the parameters (overwrites if exists)

pub fn is_empty(&self) -> Result<bool, NixlError>

Returns true if the parameters are empty

pub fn iter(&self) -> Result<ParamIterator<'_>, NixlError>

Returns an iterator over the parameter key-value pairs

Trait Implementations

impl Drop for Params

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> IntoIterator for &'a Params

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = ParamIntoIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.