Struct KiCadConnectionConfig

pub struct KiCadConnectionConfig {
    pub socket_path: String,
    pub client_name: String,
    pub kicad_token: String,
}

Configuration options passed to KiCad::new()

Fields

socket_path: String

The path to KiCad’s IPC server socket. Leave default to use the platform-dependent default path. KiCad will provide this value in an environment variable when launching API plugins.

client_name: String

The name of this API client. Leave default to generate a random client name. This name should uniquely identify a running instance of the client, especially if the user may launch more than one instance of the client at a time.

kicad_token: String

A token identifying a running instance of KiCad. Leave default to not specify a KiCad instance. The first command sent to KiCad will include that KiCad instance’s token in the response, which should then be used on subsequent commands to ensure the client can detect if a different KiCad instance is responding (for example, if KiCad is closed and re-opened by the user).

Trait Implementations

impl Debug for KiCadConnectionConfig

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

Formats the value using the given formatter.

impl Default for KiCadConnectionConfig

fn default() -> Self

Returns the “default value” for a type.