Struct Reader

Source
pub struct Reader { /* private fields */ }
Expand description

Reader for cmake-file-api replies

Example:

use cmake_file_api::{query, objects};

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

Implementations§

Source§

impl Reader

Source

pub fn from_build_dir<P: AsRef<Path>>(build_dir: P) -> Result<Self, ReaderError>

Create a new reader from a build directory

§Errors

ReaderError::FileApiNotGenerated: if the cmake-file-api is not generated for the build directory ReaderError::IO: if an IO error occurs while reading the index file ReaderError::Parse: if an error occurs while parsing the index file

Source

pub fn build_dir(&self) -> &Path

Source

pub fn index(&self) -> &Index

Source

pub fn has_object<T: Object>(&self) -> bool

Source

pub fn read_object<T: Object + DeserializeOwned>( &self, ) -> Result<T, ReaderError>

read object

§Errors

ReaderError::ObjectNotFound: if the index file does not contain the requested object ReaderError::IO: if an IO error occurs while reading the object file ReaderError::Parse: if an error occurs while parsing the object file

Auto Trait Implementations§

§

impl Freeze for Reader

§

impl RefUnwindSafe for Reader

§

impl Send for Reader

§

impl Sync for Reader

§

impl Unpin for Reader

§

impl UnwindSafe for Reader

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.