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
impl Reader
Sourcepub fn from_build_dir<P: AsRef<Path>>(build_dir: P) -> Result<Self, ReaderError>
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
pub fn build_dir(&self) -> &Path
pub fn index(&self) -> &Index
pub fn has_object<T: Object>(&self) -> bool
Sourcepub fn read_object<T: Object + DeserializeOwned>(
&self,
) -> Result<T, ReaderError>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more