Skip to main content

Cli

Struct Cli 

Source
pub struct Cli;
Expand description

A simple CLI struct for building the SSG command.

Implementations§

Source§

impl Cli

Source

pub fn build() -> Command

Builds the legacy flag-style clap::Command.

Preserved so the deprecation shim, existing examples, and the already-shipped CI invocations keep working through the 0.0.x line. Removed in 1.0 per issue #527 AC7.

§Examples
use ssg::cmd::Cli;

let cmd = Cli::build();
assert!(cmd.get_name().contains("ssg") || !cmd.get_name().is_empty());
Source

pub fn subcommand_app() -> Command

Builds the subcommand-style clap::Command (issue #527).

Surface:

ssg <SUBCOMMAND> [OPTIONS]

Development:
  dev      Start the dev server with file watching

Build:
  build    Produce a static site under the configured output dir

Validate:
  check    Run validators (read-only) and exit

Deploy:
  deploy   Build and ship to a pluggable target

Each subcommand carries the same --config / --output / … option pile so existing scripts can be ported one-to-one.

§Examples
use ssg::cmd::Cli;

let app = Cli::subcommand_app();
let names: Vec<_> = app.get_subcommands().map(|c| c.get_name()).collect();
assert!(names.contains(&"build"));
assert!(names.contains(&"dev"));
Source

pub fn parse_and_dispatch<I, T>( argv: I, ) -> Result<(CliInvocation, ArgMatches), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Routes argv to either the subcommand parser or the legacy flag parser.

The contract:

  • If argv[1] matches a known subcommand (build, dev, check, deploy, help), parses with the new surface.
  • Otherwise, falls back to the legacy parser and prints LEGACY_DEPRECATION_WARNING to stderr (issue #527 AC5, except when no args were supplied at all — bare ssg is silent and behaves like the prior 0.0.42 default).

Returns a (CliInvocation, ArgMatches) pair so the caller can reuse the existing SsgConfig::from_matches / RunOptions::from_matches helpers.

§Examples
use ssg::cmd::{Cli, CliInvocation};

let (inv, _matches) = Cli::parse_and_dispatch(vec!["ssg", "build"])
    .expect("parses");
assert!(matches!(inv, CliInvocation::Build));
§Errors

Returns the underlying clap::Error if parsing fails — the caller is expected to print it and exit non-zero.

Source

pub fn print_banner()

Displays the application banner

§Examples
use ssg::cmd::Cli;

// Prints to stdout — runnable in a doctest, no panics.
Cli::print_banner();

Trait Implementations§

Source§

impl Clone for Cli

Source§

fn clone(&self) -> Cli

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Cli

Source§

impl Debug for Cli

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Cli

Source§

fn default() -> Cli

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Cli

§

impl RefUnwindSafe for Cli

§

impl Send for Cli

§

impl Sync for Cli

§

impl Unpin for Cli

§

impl UnsafeUnpin for Cli

§

impl UnwindSafe for Cli

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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