Struct arduino_cli_client::commands::CompileReq

pub struct CompileReq {
    pub instance: Option<Instance>,
    pub fqbn: String,
    pub sketch_path: String,
    pub show_properties: bool,
    pub preprocess: bool,
    pub build_cache_path: String,
    pub build_path: String,
    pub build_properties: Vec<String>,
    pub warnings: String,
    pub verbose: bool,
    pub quiet: bool,
    pub vid_pid: String,
    pub jobs: i32,
    pub libraries: Vec<String>,
    pub optimize_for_debug: bool,
    pub export_dir: String,
    pub clean: bool,
    pub export_binaries: bool,
}

Fields

instance: Option<Instance>

Arduino Core Service instance from the Init response.

fqbn: String

Fully Qualified Board Name, e.g.: arduino:avr:uno. If this field is not defined, the FQBN of the board attached to the sketch via the BoardAttach method is used.

sketch_path: String

The path where the sketch is stored.

show_properties: bool

Show all build preferences used instead of compiling.

preprocess: bool

Print preprocessed code to stdout instead of compiling.

build_cache_path: String

Builds of 'core.a' are saved into this path to be cached and reused.

build_path: String

Path to use to store the files used for the compilation. If omitted, a directory will be created in the operating system's default temporary path.

build_properties: Vec<String>

List of custom build properties separated by commas.

warnings: String

Used to tell gcc which warning level to use. The level names are: "none", "default", "more" and "all".

verbose: bool

Turns on verbose mode.

quiet: bool

Suppresses almost every output.

vid_pid: String

VID/PID specific build properties.

jobs: i32

The max number of concurrent compiler instances to run (as make -jx). If jobs is set to 0, it will use the number of available CPUs as the maximum.

libraries: Vec<String>

List of custom libraries paths separated by commas.

optimize_for_debug: bool

Optimize compile output for debug, not for release.

export_dir: String

Optional: save the build artifacts in this directory, the directory must exist.

clean: bool

Optional: cleanup the build folder and do not use any previously cached build

export_binaries: bool

When set to true the compiled binary will be copied to the export directory.

Trait Implementations

impl Clone for CompileReq

fn clone(&self) -> CompileReq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompileReq

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

Formats the value using the given formatter.

impl Default for CompileReq

fn default() -> CompileReq

Returns the "default value" for a type.

impl Message for CompileReq

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<CompileReq> for CompileReq

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

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

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

This method tests for !=.

impl StructuralPartialEq for CompileReq