Struct carbone_sdk_rust::config::Config

pub struct Config {
    pub api_url: String,
    pub api_timeout: u64,
    pub api_version: ApiVersion,
}

Fields

api_url: String

api_timeout: u64

api_version: ApiVersion

Implementations

impl Config

pub fn new( api_url: String, api_timeout: u64, api_version: ApiVersion ) -> Result<Self>

Create a new Configuraiton.

This function will create new Config.

Example

use carbone_sdk_rs::config::Config;
use carbone_sdk_rs::errors::CarboneError;
use carbone_sdk_rs::types::ApiVersion;

fn main() -> Result<(), CarboneError> {
    let api_version: ApiVersion = ApiVersion::new("4".to_string())?;
    let config = Config::new(
       "http://127.0.0.1:57780".to_string(),
       4,
       api_version)?;
    Ok(())
}

pub fn from_file(path: &str) -> Result<Self>

Load a Configuraiton from a file.

This function will create new Config struct with, the values from the file.

Example

use carbone_sdk_rs::config::Config;
use carbone_sdk_rs::errors::CarboneError;

fn main() -> Result<(), CarboneError> {
    let config = Config::from_file("tests/config.test.json")?;
    Ok(())
}

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

Load a Default Configuraiton.

This function will create new Config struct the with, the default values.

Example

use carbone_sdk_rs::config::Config;
use carbone_sdk_rs::errors::CarboneError;

fn main() -> Result<(), CarboneError> {

   let config: Config = Default::default();
    
    assert_eq!(config.api_url, "https://api.carbone.io".to_string());

    Ok(())
}

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Config

Load a Configuraiton from a str.

This function will create new Config struct with, the values from the str given.

Example

use std::str::FromStr;
use carbone_sdk_rs::config::Config;
use carbone_sdk_rs::errors::CarboneError;

fn main() -> Result<(), CarboneError> {
     
    let config = Config::from_str(r#"{
        "apiUrl": "http://127.0.0.1",
        "apiTimeout": 4,
        "apiVersion" : "4"
    }"#)?;

    Ok(())
}

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Validate for Config

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Config

type Args = ()

fn validate_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config