Struct ArduinoCoreClient

pub struct ArduinoCoreClient<T> { /* private fields */ }

The main Arduino Platform Service

Implementations

impl ArduinoCoreClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> ArduinoCoreClient<T>

where T: GrpcService<BoxBody>, T::ResponseBody: Body + HttpBody + Send + 'static, T::Error: Into<StdError>, <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn init( &mut self, request: impl IntoRequest<InitReq>, ) -> Result<Response<Streaming<InitResp>>, Status>

Start a new instance of the Arduino Core Service

pub async fn destroy( &mut self, request: impl IntoRequest<DestroyReq>, ) -> Result<Response<DestroyResp>, Status>

Destroy an instance of the Arduino Core Service

pub async fn rescan( &mut self, request: impl IntoRequest<RescanReq>, ) -> Result<Response<RescanResp>, Status>

Rescan instance of the Arduino Core Service

pub async fn update_index( &mut self, request: impl IntoRequest<UpdateIndexReq>, ) -> Result<Response<Streaming<UpdateIndexResp>>, Status>

Update package index of the Arduino Core Service

pub async fn update_libraries_index( &mut self, request: impl IntoRequest<UpdateLibrariesIndexReq>, ) -> Result<Response<Streaming<UpdateLibrariesIndexResp>>, Status>

Update libraries index

pub async fn update_core_libraries_index( &mut self, request: impl IntoRequest<UpdateCoreLibrariesIndexReq>, ) -> Result<Response<Streaming<UpdateCoreLibrariesIndexResp>>, Status>

Update packages indexes for both Cores and Libraries

pub async fn outdated( &mut self, request: impl IntoRequest<OutdatedReq>, ) -> Result<Response<OutdatedResp>, Status>

Outdated returns a message with a list of outdated Cores and Libraries

pub async fn upgrade( &mut self, request: impl IntoRequest<UpgradeReq>, ) -> Result<Response<Streaming<UpgradeResp>>, Status>

Upgrade both Cores and Libraries

pub async fn version( &mut self, request: impl IntoRequest<VersionReq>, ) -> Result<Response<VersionResp>, Status>

Get the version of Arduino CLI in use.

pub async fn load_sketch( &mut self, request: impl IntoRequest<LoadSketchReq>, ) -> Result<Response<LoadSketchResp>, Status>

Returns all files composing a Sketch

pub async fn archive_sketch( &mut self, request: impl IntoRequest<ArchiveSketchReq>, ) -> Result<Response<ArchiveSketchResp>, Status>

Creates a zip file containing all files of specified Sketch

pub async fn board_details( &mut self, request: impl IntoRequest<BoardDetailsReq>, ) -> Result<Response<BoardDetailsResp>, Status>

Requests details about a board

pub async fn board_attach( &mut self, request: impl IntoRequest<BoardAttachReq>, ) -> Result<Response<Streaming<BoardAttachResp>>, Status>

Attach a board to a sketch. When the fqbn field of a request is not provided, the FQBN of the attached board will be used.

pub async fn board_list( &mut self, request: impl IntoRequest<BoardListReq>, ) -> Result<Response<BoardListResp>, Status>

List the boards currently connected to the computer.

pub async fn board_list_all( &mut self, request: impl IntoRequest<BoardListAllReq>, ) -> Result<Response<BoardListAllResp>, Status>

List all the boards provided by installed platforms.

pub async fn board_list_watch( &mut self, request: impl IntoStreamingRequest<Message = BoardListWatchReq>, ) -> Result<Response<Streaming<BoardListWatchResp>>, Status>

List boards connection and disconnected events.

pub async fn compile( &mut self, request: impl IntoRequest<CompileReq>, ) -> Result<Response<Streaming<CompileResp>>, Status>

Compile an Arduino sketch.

pub async fn platform_install( &mut self, request: impl IntoRequest<PlatformInstallReq>, ) -> Result<Response<Streaming<PlatformInstallResp>>, Status>

Download and install a platform and its tool dependencies.

pub async fn platform_download( &mut self, request: impl IntoRequest<PlatformDownloadReq>, ) -> Result<Response<Streaming<PlatformDownloadResp>>, Status>

Download a platform and its tool dependencies to the staging/packages subdirectory of the data directory.

pub async fn platform_uninstall( &mut self, request: impl IntoRequest<PlatformUninstallReq>, ) -> Result<Response<Streaming<PlatformUninstallResp>>, Status>

Uninstall a platform as well as its tool dependencies that are not used by other installed platforms.

pub async fn platform_upgrade( &mut self, request: impl IntoRequest<PlatformUpgradeReq>, ) -> Result<Response<Streaming<PlatformUpgradeResp>>, Status>

Upgrade an installed platform to the latest version.

pub async fn upload( &mut self, request: impl IntoRequest<UploadReq>, ) -> Result<Response<Streaming<UploadResp>>, Status>

Upload a compiled sketch to a board.

pub async fn upload_using_programmer( &mut self, request: impl IntoRequest<UploadUsingProgrammerReq>, ) -> Result<Response<Streaming<UploadUsingProgrammerResp>>, Status>

Upload a compiled sketch to a board using a programmer.

pub async fn list_programmers_available_for_upload( &mut self, request: impl IntoRequest<ListProgrammersAvailableForUploadReq>, ) -> Result<Response<ListProgrammersAvailableForUploadResp>, Status>

List programmers available for a board.

pub async fn burn_bootloader( &mut self, request: impl IntoRequest<BurnBootloaderReq>, ) -> Result<Response<Streaming<BurnBootloaderResp>>, Status>

Burn bootloader to a board.

pub async fn platform_search( &mut self, request: impl IntoRequest<PlatformSearchReq>, ) -> Result<Response<PlatformSearchResp>, Status>

Search for a platform in the platforms indexes.

pub async fn platform_list( &mut self, request: impl IntoRequest<PlatformListReq>, ) -> Result<Response<PlatformListResp>, Status>

List all installed platforms.

pub async fn library_download( &mut self, request: impl IntoRequest<LibraryDownloadReq>, ) -> Result<Response<Streaming<LibraryDownloadResp>>, Status>

Download the archive file of an Arduino library in the libraries index to the staging directory.

pub async fn library_install( &mut self, request: impl IntoRequest<LibraryInstallReq>, ) -> Result<Response<Streaming<LibraryInstallResp>>, Status>

Download and install an Arduino library from the libraries index.

pub async fn zip_library_install( &mut self, request: impl IntoRequest<ZipLibraryInstallReq>, ) -> Result<Response<Streaming<ZipLibraryInstallResp>>, Status>

Install a library from a Zip File

pub async fn git_library_install( &mut self, request: impl IntoRequest<GitLibraryInstallReq>, ) -> Result<Response<Streaming<GitLibraryInstallResp>>, Status>

Download and install a library from a git url

pub async fn library_uninstall( &mut self, request: impl IntoRequest<LibraryUninstallReq>, ) -> Result<Response<Streaming<LibraryUninstallResp>>, Status>

Uninstall an Arduino library.

pub async fn library_upgrade_all( &mut self, request: impl IntoRequest<LibraryUpgradeAllReq>, ) -> Result<Response<Streaming<LibraryUpgradeAllResp>>, Status>

Upgrade all installed Arduino libraries to the newest version available.

pub async fn library_resolve_dependencies( &mut self, request: impl IntoRequest<LibraryResolveDependenciesReq>, ) -> Result<Response<LibraryResolveDependenciesResp>, Status>

List the recursive dependencies of a library, as defined by the depends field of the library.properties files.

pub async fn library_search( &mut self, request: impl IntoRequest<LibrarySearchReq>, ) -> Result<Response<LibrarySearchResp>, Status>

Search the Arduino libraries index for libraries.

pub async fn library_list( &mut self, request: impl IntoRequest<LibraryListReq>, ) -> Result<Response<LibraryListResp>, Status>

List the installed libraries.

Trait Implementations

impl<T: Clone> Clone for ArduinoCoreClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ArduinoCoreClient<T>

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

Formats the value using the given formatter.