Skip to main content

HistoryCommand

Enum HistoryCommand 

Source
pub enum HistoryCommand {
    List {
        outcome: Option<OutcomeArg>,
        limit: i64,
        offset: i64,
        output: OutputFormat,
    },
    Show {
        run_id: i64,
        output: OutputFormat,
    },
    Revert {
        run_id: i64,
        bridge_host: Option<String>,
        server: Option<String>,
        yes: bool,
        output: OutputFormat,
    },
    Prune {
        older_than_days: Option<u32>,
        dry_run: bool,
        output: OutputFormat,
    },
}

Variants§

§

List

List past runs, newest first.

Fields

§limit: i64
§offset: i64
§output: OutputFormat

How to print the run list.

§

Show

Show one run’s full detail: config, initial readings, calculated results, and any PID write-back audit rows.

Fields

§run_id: i64
§output: OutputFormat

How to print the run detail.

§

Revert

Undo a run’s PID write-back, writing its recorded pre-write P/I/D values back to the live loop. Reverts whichever write-kind write-back that run last recorded; refuses if the run has none, if that write-back’s pre-read itself failed (nothing to revert to), or if the run did not use the opcda driver (nothing live to revert against).

Fields

§run_id: i64
§bridge_host: Option<String>

Cross-checked against the run’s own recorded bridge host – never used to resolve a default, and deliberately has no BHTUNE_BRIDGE_HOST/config fallback the way every other command’s --bridge-host does, so an unrelated ambient env var can never silently affect which gateway a revert targets. Omit this to use the recorded value; a value that contradicts it is refused rather than preferred, so a revert can never target a different gateway than the run it is undoing actually used (db-run-request-snapshot).

§server: Option<String>

Cross-checked against the run’s own recorded OPC server – never used to resolve a default. Omit this to use the recorded value; a value that contradicts it is refused rather than preferred, so a revert can never target a different server than the run it is undoing actually used (db-run-request-snapshot).

§yes: bool

Confirm writing to a live loop. Required – there is no interactive prompt for reverting, since there is no calculated result to choose between as there is for tune’s own write-back step.

§output: OutputFormat

How to print the revert outcome.

§

Prune

Delete runs older than the configured retention policy (history-retention), without waiting for the next automatic startup sweep.

Fields

§older_than_days: Option<u32>

Delete runs older than this many days, overriding the configured retention_days policy for this invocation only. Required if no retention policy is configured at all (--retention-days / BHTUNE_RETENTION_DAYS / the config file’s retention_days key) – there is no default “prune everything older than X” to fall back to.

§dry_run: bool

Report how many runs would be deleted, and as of what cutoff, without deleting anything.

§output: OutputFormat

How to print the prune outcome.

Trait Implementations§

Source§

impl Debug for HistoryCommand

Source§

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

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

impl FromArgMatches for HistoryCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for HistoryCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut] Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut] Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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.

§

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

§

fn into_request(self) -> Request<T>

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

impl<L> LayerExt<L> for L

§

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

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