Skip to main content

CreateSchemaCommandHandler

Struct CreateSchemaCommandHandler 

Source
pub struct CreateSchemaCommandHandler;
Expand description

Handler for creating JSON Schema from configuration types

This handler orchestrates schema generation and output handling, supporting both stdout and file output.

§Architecture

  • No Step layer needed (single operation)
  • Delegates schema generation to SchemaGenerator (Infrastructure)
  • Handles output routing (stdout vs file)

§Examples

use torrust_tracker_deployer_lib::application::command_handlers::create::schema::CreateSchemaCommandHandler;
use std::path::PathBuf;
use tempfile::TempDir;

// Generate to stdout
let schema = CreateSchemaCommandHandler::execute(None)?;
println!("{}", schema);

// Generate to file (use temp directory to avoid leaving artifacts)
let temp_dir = TempDir::new()?;
let schema_path = temp_dir.path().join("schema.json");
CreateSchemaCommandHandler::execute(Some(schema_path))?;

Implementations§

Source§

impl CreateSchemaCommandHandler

Source

pub fn execute( output_path: Option<PathBuf>, ) -> Result<String, CreateSchemaCommandHandlerError>

Executes the create schema command

Generates JSON Schema for EnvironmentCreationConfig and either writes it to a file or returns it as a string.

§Arguments
  • output_path - Optional path to write schema file. If None, returns schema as string.
§Returns
  • Ok(String) - The generated schema (for stdout output or testing)
  • Err(CreateSchemaCommandHandlerError) - If generation or file writing fails
§Output Behavior
  • No path: Returns schema string (caller handles stdout)
  • With path: Writes to file and returns the schema string
§Examples
use torrust_tracker_deployer_lib::application::command_handlers::create::schema::CreateSchemaCommandHandler;
use std::path::PathBuf;
use tempfile::TempDir;

// Output to stdout (caller prints the returned string)
let schema = CreateSchemaCommandHandler::execute(None)?;
println!("{}", schema);

// Output to file (use temp directory to avoid leaving artifacts)
let temp_dir = TempDir::new()?;
let schema_path = temp_dir.path().join("schema.json");
let schema = CreateSchemaCommandHandler::execute(Some(schema_path))?;
// File is written, schema string also returned for confirmation
§Errors

Returns error if:

  • Schema generation fails (infrastructure error)
  • Parent directory creation fails (when writing to file)
  • File write fails (when writing to file)

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more