Struct lava_api::Lava

pub struct Lava { /* private fields */ }

A local proxy for a LAVA server

This provides convenient access to some of the data stored on a LAVA server, including jobs, devices, tags and workers.

Implementations

impl Lava

pub fn new(url: &str, token: Option<String>) -> Result<Lava, LavaError>

Create a new Lava proxy

Here url is the address of the server, and token is an optional LAVA security token used to validate access.

pub async fn refresh_tags(&self) -> Result<(), PaginationError>

Refresh the tag cache

Tags are cached to make lookup cheaper, and because the number of jobs can be very large: resolving tags individually for each job would be extremely slow. The cache has to be periodically refreshed to account for changes.

Note that tags are automatically refreshed by calling tag or tags, but not by calling devices or jobs.

pub async fn tag(&self, tag: u32) -> Option<Tag>

Retrieve the Tag for the given tag id.

pub async fn tags(&self) -> Result<Vec<Tag>, PaginationError>

Retrieve all the tags from the server

The returned data is not a stream, but a flat vector when the method succeeds. This also updates the tag cache.

pub fn devices(&self) -> Devices<'_>

Obtain a Stream of all the Device instances on the server.

pub fn log(&self, id: i64) -> JobLogBuilder<'_>

pub fn jobs(&self) -> JobsBuilder<'_>

Obtain a customisable query object for Job instances on the server.

The returned JobsBuilder can be used first to select the subset of jobs that will be returned, and then after that is complete to obtain a stream of matching jobs. The default query is the same as that for JobsBuilder::new.

pub async fn submit_job(
    &self,
    definition: &str
) -> Result<Vec<i64>, SubmissionError>

pub async fn cancel_job(&self, id: i64) -> Result<(), CancellationError>

pub async fn job_results_as_junit(
    &self,
    id: i64
) -> Result<impl Stream<Item = Result<Bytes, ResultsError>> + '_, ResultsError>

pub fn workers(&self) -> Paginator<Worker>

Obtain a Stream of all the Worker instances on the server.

pub fn test_cases(&self, job_id: i64) -> Paginator<TestCase>

Obtain a Stream of all the TestCase instances for a given job id.

Trait Implementations

impl Debug for Lava

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

Formats the value using the given formatter.