WikiUseCase

adrscope::application

Struct WikiUseCase 

Source 
pub struct WikiUseCase<F: FileSystem> { /* private fields */ }
Expand description

Use case for generating GitHub Wiki pages.

Implementations§

Source§

impl<F: FileSystem> WikiUseCase<F>

Source

pub fn new(fs: F) -> Self

Creates a new wiki use case.

Source

pub fn execute(&self, options: &WikiOptions) -> Result<WikiResult>

Executes the wiki generation use case.

§Errors

Returns an error if:

  • No ADR files are found
  • File reading fails
  • Parsing fails
  • File writing fails

Trait Implementations§

Source§

impl<F: Debug + FileSystem> Debug for WikiUseCase<F>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for WikiUseCase<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for WikiUseCase<F>
where F: RefUnwindSafe,

§

impl<F> Send for WikiUseCase<F>

§

impl<F> Sync for WikiUseCase<F>

§

impl<F> Unpin for WikiUseCase<F>
where F: Unpin,

§

impl<F> UnwindSafe for WikiUseCase<F>
where F: UnwindSafe,

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.