pub struct SchemaExportService;Expand description
Generates docs/schemas/-style reference docs (raw JSON Schema files plus a
Markdown field reference) from every schema this CLI knows about. See the
module-level docs for what “knows about” means and why nothing here
hand-writes schema content.
Implementations§
Source§impl SchemaExportService
impl SchemaExportService
Sourcepub fn export(out_dir: &Path) -> Result<Vec<PathBuf>>
pub fn export(out_dir: &Path) -> Result<Vec<PathBuf>>
Generate every schema this CLI knows about and write it under out_dir:
raw JSON Schema files plus a single README.md field reference. Returns
the list of files written (relative to out_dir), for callers that want
to report what changed.
§Errors
Returns an error if out_dir can’t be created, or a file can’t be written.
Auto Trait Implementations§
impl Freeze for SchemaExportService
impl RefUnwindSafe for SchemaExportService
impl Send for SchemaExportService
impl Sync for SchemaExportService
impl Unpin for SchemaExportService
impl UnsafeUnpin for SchemaExportService
impl UnwindSafe for SchemaExportService
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 more