Struct Parameters 

pub struct Parameters {
    pub version: f32,
    pub encryption: Option<ParameterEncryption>,
    pub scenarios: Option<Vec<Scenario>>,
    pub authorizations: Option<Vec<Authorization>>,
    pub certificates: Option<Vec<Certificate>>,
    pub proxies: Option<Vec<Proxy>>,
}

Stored parameters, authorization, client certificates and proxies stored outside of a workbook, either globally or alongside a workbook

Fields

version: f32

Version of format (should not be changed manually)

encryption: Option<ParameterEncryption>

Encryption

scenarios: Option<Vec<Scenario>>

Scenarios

authorizations: Option<Vec<Authorization>>

Authorizations

certificates: Option<Vec<Certificate>>

Certificates

proxies: Option<Vec<Proxy>>

Proxy servers

Implementations

impl Parameters

pub fn new( scenarios: Option<Vec<Scenario>>, authorizations: Option<Vec<Authorization>>, certificates: Option<Vec<Certificate>>, proxies: Option<Vec<Proxy>>, ) -> Self

pub fn open( file_name: &PathBuf, create_new_if_missing: bool, ) -> Result<Parameters, ApicizeError>

Open parameters from parameters file; or, if specified, create default if parameters file does not exist

pub fn save( &self, file_name: &PathBuf, destination_name: &str, password: &Option<String>, ) -> Result<SerializationSaveSuccess, ApicizeError>

Save parametesr to file if it contains entries, otherwise, delete it

pub fn get_parameter_count(&self) -> usize

pub fn get_globals_filename() -> PathBuf

Return the file name for globals

pub fn get_workbook_private_filename(workbook_path: &Path) -> PathBuf

Return the file name for a workbook’s private parameters file

pub fn any_encyrypted(&self) -> bool

Return true if any paramerers are encrypted

pub fn encyrpt( &mut self, password: &str, method: ParameterEncryption, ) -> Result<Parameters, ApicizeError>

Encrypt any plain entries

pub fn decrypt( &mut self, password: Option<&str>, fallback_env_variable: Option<&str>, ) -> (ParameterLockStatus, Option<String>)

Decrypt the listed parameters, when encrypted, using password, if specified, or fallback env variable,if defined; returns the lock status and active password

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Parameters

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Parameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Parameters

fn eq(&self, other: &Parameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Parameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameters