pub struct Parser { /* private fields */ }Implementations§
Source§impl Parser
impl Parser
pub fn new(config: &BuildConfig) -> Result<Self>
Sourcepub fn with_srcdir(self, srcdir: PathBuf) -> Self
pub fn with_srcdir(self, srcdir: PathBuf) -> Self
Attach the project source directory (sphinx env.srcdir), enabling
the include directive’s sphinx-mode path resolution and its
included/dependencies recording.
pub fn parse( &self, file_path: &Path, content: &str, docname: &str, ) -> Result<Document>
Sourcepub fn parse_full(
&self,
file_path: &Path,
content: &str,
docname: &str,
found_docs: Option<Arc<BTreeSet<String>>>,
) -> Result<ParsedFile>
pub fn parse_full( &self, file_path: &Path, content: &str, docname: &str, found_docs: Option<Arc<BTreeSet<String>>>, ) -> Result<ParsedFile>
Parse one source file, keeping the doctree.
found_docs is the project’s full docname set (sphinx
env.found_docs), which the toctree directive resolves its entries
against; None parses without an environment (see
crate::rst::ParseOptions::found_docs).
Auto Trait Implementations§
impl Freeze for Parser
impl RefUnwindSafe for Parser
impl Send for Parser
impl Sync for Parser
impl Unpin for Parser
impl UnsafeUnpin for Parser
impl UnwindSafe for Parser
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> 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 more