pub struct IncrementalParser<R: Read + Seek, S: ParseState> { /* private fields */ }Expand description
An incremental parser for braid archives.
Initially, minimal reading from the archive is performed. As further operations on the archive proceed, the state of the parser gradually accumulates more information.
Implementations§
Source§impl IncrementalParser<BufReader<File>, ArchiveOpened>
impl IncrementalParser<BufReader<File>, ArchiveOpened>
Source§impl<R: Read + Seek> IncrementalParser<R, ArchiveOpened>
impl<R: Read + Seek> IncrementalParser<R, ArchiveOpened>
Sourcepub fn from_archive(archive: ZipDirArchive<R>) -> Self
pub fn from_archive(archive: ZipDirArchive<R>) -> Self
Open an archive.
The archive may be a .braidz zip file for a .braid directory.
Sourcepub fn parse_basics(
self,
) -> Result<IncrementalParser<R, BasicInfoParsed>, Error>
pub fn parse_basics( self, ) -> Result<IncrementalParser<R, BasicInfoParsed>, Error>
Parse the basic data which can be quickly read from the archive.
Sourcepub fn parse_everything(
self,
) -> Result<IncrementalParser<R, FullyParsed>, Error>
pub fn parse_everything( self, ) -> Result<IncrementalParser<R, FullyParsed>, Error>
Parse the entire archive.
Source§impl<R: Read + Seek> IncrementalParser<R, BasicInfoParsed>
impl<R: Read + Seek> IncrementalParser<R, BasicInfoParsed>
Sourcepub fn parse_rest(self) -> Result<IncrementalParser<R, FullyParsed>, Error>
pub fn parse_rest(self) -> Result<IncrementalParser<R, FullyParsed>, Error>
Parse the remaining aspects of the archive.
pub fn basic_info(&self) -> &BasicInfoParsed
Source§impl<R: Read + Seek> IncrementalParser<R, FullyParsed>
impl<R: Read + Seek> IncrementalParser<R, FullyParsed>
pub fn kalman_estimates_info(&self) -> Option<&KalmanEstimatesInfo>
Source§impl<R: Read + Seek, S: ParseState> IncrementalParser<R, S>
impl<R: Read + Seek, S: ParseState> IncrementalParser<R, S>
Sourcepub fn into_inner(self) -> ZipDirArchive<R>
pub fn into_inner(self) -> ZipDirArchive<R>
Consume and return the raw storage archive.
Sourcepub fn path_starter(&mut self) -> PathLike<'_, R>
pub fn path_starter(&mut self) -> PathLike<'_, R>
Get a path-like instance for direct read access to the archive.
You should prefer to use information already parsed from the archive rather than resorting to this low-level function. Consider expanding the parser to provide this information if it is not already implemented.
Trait Implementations§
Auto Trait Implementations§
impl<R, S> Freeze for IncrementalParser<R, S>
impl<R, S> RefUnwindSafe for IncrementalParser<R, S>where
S: RefUnwindSafe,
R: RefUnwindSafe,
impl<R, S> Send for IncrementalParser<R, S>
impl<R, S> Sync for IncrementalParser<R, S>
impl<R, S> Unpin for IncrementalParser<R, S>
impl<R, S> UnsafeUnpin for IncrementalParser<R, S>where
S: UnsafeUnpin,
R: UnsafeUnpin,
impl<R, S> UnwindSafe for IncrementalParser<R, S>where
S: UnwindSafe,
R: UnwindSafe,
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
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.