pub struct Readme {
pub markdown: Markdown,
}Fields§
§markdown: MarkdownImplementations§
Source§impl Readme
impl Readme
pub fn from_file(file_path: impl AsRef<Path>) -> Result<Readme, ReadmeError>
pub fn from_str(str: impl Into<String>) -> Readme
pub fn from_lines(lines: &[impl AsRef<str>]) -> Readme
pub fn lines(&self) -> impl Iterator<Item = &str>
pub fn write_to_file( &self, file: impl AsRef<Path>, line_terminator: LineTerminator, ) -> Result<(), ReadmeError>
pub fn write( &self, writer: impl Write, line_terminator: LineTerminator, ) -> Result<(), ReadmeError>
pub fn as_string(&self) -> &str
Auto Trait Implementations§
impl Freeze for Readme
impl RefUnwindSafe for Readme
impl Send for Readme
impl Sync for Readme
impl Unpin for Readme
impl UnwindSafe for Readme
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