pub struct DocsCommandController { /* private fields */ }Expand description
Controller for docs command
Handles the presentation layer for CLI JSON documentation generation, coordinating between the command handler and user output.
Implementations§
Source§impl DocsCommandController
impl DocsCommandController
Sourcepub fn new(user_output: &Arc<ReentrantMutex<RefCell<UserOutput>>>) -> Self
pub fn new(user_output: &Arc<ReentrantMutex<RefCell<UserOutput>>>) -> Self
Create a new CLI documentation generation command controller
Sourcepub fn execute(
&mut self,
output_path: Option<&PathBuf>,
) -> Result<(), DocsCommandError>
pub fn execute( &mut self, output_path: Option<&PathBuf>, ) -> Result<(), DocsCommandError>
Execute the CLI documentation generation command
Generates CLI JSON documentation and either writes to file or outputs to stdout.
§Arguments
output_path- Optional path to write schema file. IfNone, outputs to stdout.
§Returns
Returns Ok(()) on success, or error if generation or output fails.
§Errors
Returns error if:
- CLI documentation generation fails
- File write fails (when path provided)
- Parent directory creation fails (when path provided)
- Stdout write fails (when no path provided)
Auto Trait Implementations§
impl !RefUnwindSafe for DocsCommandController
impl !UnwindSafe for DocsCommandController
impl Freeze for DocsCommandController
impl Send for DocsCommandController
impl Sync for DocsCommandController
impl Unpin for DocsCommandController
impl UnsafeUnpin for DocsCommandController
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> 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<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request