FormatConverter

Struct FormatConverter 

Source
pub struct FormatConverter;
Expand description

Converts specs between YAML and Markdown formats

Implementations§

Source§

impl FormatConverter

Source

pub fn yaml_to_markdown(yaml_content: &str) -> Result<String, SpecError>

Convert a spec from YAML format to Markdown format

§Arguments
  • yaml_content - The YAML spec content as a string
§Returns

The spec converted to Markdown format, or an error if parsing/validation fails

§Errors

Returns SpecError if:

  • The YAML content cannot be parsed
  • The parsed spec fails validation
Source

pub fn markdown_to_yaml(markdown_content: &str) -> Result<String, SpecError>

Convert a spec from Markdown format to YAML format

§Arguments
  • markdown_content - The Markdown spec content as a string
§Returns

The spec converted to YAML format, or an error if parsing/validation fails

§Errors

Returns SpecError if:

  • The Markdown content cannot be parsed
  • The parsed spec fails validation
Source

pub fn convert( content: &str, from_format: &str, to_format: &str, ) -> Result<String, SpecError>

Convert a spec from one format to another

§Arguments
  • content - The spec content as a string
  • from_format - The source format (“yaml” or “markdown”)
  • to_format - The target format (“yaml” or “markdown”)
§Returns

The spec converted to the target format, or an error if conversion fails

§Errors

Returns SpecError if:

  • The source format is invalid
  • The content cannot be parsed
  • The parsed spec fails validation

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, 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.
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