Struct Writer

pub struct Writer { /* private fields */ }

Write queries for cmake-file-api.

Example

use cmake_file_api::{query, objects};

query::Writer::default()
  .request_object::<objects::CodeModelV2>()
  .write_stateless(&build_dir)
  .expect("Failed to write query");

Implementations

impl Writer

pub fn request_object<T: Object>(&mut self) -> &mut Self

Request cmake-file-api object

pub fn add_request_exact<T: Object>(&mut self, minor: u32) -> &mut Self

Request cmake-file-api object with exact version (minor version only used for stateful queries)

pub fn request_all_objects(&mut self) -> &mut Self

Helper function to request all objects

pub fn set_client(&mut self, client_name: &str, client_data: Value) -> &mut Self

Set client data Only used for stateful queries

Arguments

• client_name - Client name
• client_data - Client data (JSON)

pub fn write_stateless<P: AsRef<Path>>( &self, build_dir: P, ) -> Result<(), WriterError>

Write stateless query For every object requested, a file is created in the query folder e.g. <build_dir>/.cmake/api/v1/query/codemodel-v2

Errors

Returns an error if the query folder could not be created Returns an error if the query file could not be written

pub fn write_stateful<P: AsRef<Path>>( &self, build_dir: P, ) -> Result<(), WriterError>

Write stateful query A single <client-name>/query.json file is created in the query folder containing all requested objects and when set the client data

Arguments

• build_dir - Build directory

Errors

Returns an error if the query file could not be written

Trait Implementations

impl Default for Writer

fn default() -> Writer

Returns the “default value” for a type.