Struct arduino_cli_client::commands::Library

pub struct Library {
    pub name: String,
    pub author: String,
    pub maintainer: String,
    pub sentence: String,
    pub paragraph: String,
    pub website: String,
    pub category: String,
    pub architectures: Vec<String>,
    pub types: Vec<String>,
    pub install_dir: String,
    pub source_dir: String,
    pub utility_dir: String,
    pub container_platform: String,
    pub real_name: String,
    pub dot_a_linkage: bool,
    pub precompiled: bool,
    pub ld_flags: String,
    pub is_legacy: bool,
    pub version: String,
    pub license: String,
    pub properties: HashMap<String, String>,
    pub location: i32,
    pub layout: i32,
    pub examples: Vec<String>,
    pub provides_includes: Vec<String>,
    pub compatible_with: HashMap<String, bool>,
}

Fields

name: String

The library's directory name.

author: String

Value of the author field in library.properties.

maintainer: String

Value of the maintainer field in library.properties.

sentence: String

Value of the sentence field in library.properties.

paragraph: String

Value of the paragraph field in library.properties.

website: String

Value of the url field in library.properties.

category: String

Value of the category field in library.properties.

architectures: Vec<String>

Value of the architectures field in library.properties.

types: Vec<String>

The type categories of the library. Possible values: Arduino, Partner, Recommended, Contributed, Retired.

install_dir: String

The path of the library directory.

source_dir: String

The location of the library's source files.

utility_dir: String

The location of the library's utility directory.

container_platform: String

If location is platform_builtin or referenced_platform_builtin, the identifying string for the platform containing the library (e.g., arduino:avr@1.8.2).

real_name: String

Value of the name field in library.properties.

dot_a_linkage: bool

Value of the dot_a_linkage field in library.properties.

precompiled: bool

Value of the precompiled field in library.properties.

ld_flags: String

Value of the ldflags field in library.properties.

is_legacy: bool

A library.properties file is not present in the library's root directory.

version: String

Value of the version field in library.properties.

license: String

Value of the license field in library.properties.

properties: HashMap<String, String>

The data from the library's library.properties file, including unused fields.

location: i32

The location type of the library installation.

layout: i32

The library format type.

examples: Vec<String>

The example sketches provided by the library

provides_includes: Vec<String>

Value of the includes field in library.properties or, if missing, the list of include files available on the library source root directory.

compatible_with: HashMap<String, bool>

Map of FQBNs that specifies if library is compatible with this library

Implementations

impl Library

pub fn location(&self) -> LibraryLocation

Returns the enum value of location, or the default if the field is set to an invalid enum value.

pub fn set_location(&mut self, value: LibraryLocation)

Sets location to the provided enum value.

pub fn layout(&self) -> LibraryLayout

Returns the enum value of layout, or the default if the field is set to an invalid enum value.

pub fn set_layout(&mut self, value: LibraryLayout)

Sets layout to the provided enum value.

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Library

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

Formats the value using the given formatter.

impl Default for Library

fn default() -> Library

Returns the "default value" for a type.

impl Message for Library

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<Library> for Library

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

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

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

This method tests for !=.

impl StructuralPartialEq for Library