Struct Builder 

pub struct Builder { /* private fields */ }

Implementations

impl Builder

pub fn with_config(config: Config) -> Self

Creates a config file builder based on a Config.

Examples found in repository

examples/ready_made_components.rs (lines 4-8)

fn main() {
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Components::ALL.into(),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

examples/own_set_components.rs (lines 8-12)

fn main() {
    let components: &[Components] = &[Components::Provider, Components::PlayerId];
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Data::from(components),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

pub fn build(&mut self) -> &mut Self

Serializes the Config to a string ready to be written in a cfg file.

Examples found in repository

examples/ready_made_components.rs (line 10)

fn main() {
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Components::ALL.into(),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

examples/own_set_components.rs (line 14)

fn main() {
    let components: &[Components] = &[Components::Provider, Components::PlayerId];
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Data::from(components),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

pub fn output(&self) -> String

Gets the serialized Config.

This method must only be called after build.

pub fn install<P: Into<PathBuf>>( &self, folder_path: P, ) -> Result<(), Box<dyn Error>>

Write the serialized Config to a cfg file at the path passed in argument.

Examples found in repository

examples/ready_made_components.rs (line 11)

fn main() {
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Components::ALL.into(),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

examples/own_set_components.rs (line 15)

fn main() {
    let components: &[Components] = &[Components::Provider, Components::PlayerId];
    let mut config_builder = Builder::with_config(Config {
        name: String::from("my_gsi_config_file"),
        data: Data::from(components),
        ..Default::default()
    });
    config_builder
        .build()
        .install("C:\\Counter-Strike Global Offensive\\csgo\\cfg")
        .unwrap();
}

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.