Skip to main content

RecurringAction

Enum RecurringAction 

Source
pub enum RecurringAction {
    List,
    Show {
        series: String,
    },
    Create(RecurringCreateArgs),
    Edit {
        series: String,
        args: RecurringEditArgs,
    },
    Detect {
        date: Option<String>,
        timezone: Option<String>,
    },
    Generate {
        series: String,
        date: String,
        confirmation: RecurringLifecycleArgs,
    },
    Pause {
        series: String,
        confirmation: RecurringLifecycleArgs,
    },
    Resume {
        series: String,
        confirmation: RecurringLifecycleArgs,
    },
    End {
        series: String,
        confirmation: RecurringLifecycleArgs,
    },
    Skip {
        series: String,
        date: String,
        confirmation: RecurringLifecycleArgs,
    },
    Defer {
        series: String,
        date: String,
        confirmation: RecurringLifecycleArgs,
    },
    Ignore {
        series: String,
        date: String,
        confirmation: RecurringLifecycleArgs,
    },
}
Expand description

What tix recurring does.

Every read-only subcommand resolves its date explicitly (--date), and every mutating one requires the confirmation flag it documents. The subcommands are a thin adapter: they parse, call one service, and print.

Variants§

§

List

List every series, one tab-separated row per series

Columns: id, name, state, next_cursor, skipped.

§

Show

Show one series: identity, rule, state, cursor, skipped dates, occurrences

Fields

§series: String

Stable series id, or its unique display name

§

Create(RecurringCreateArgs)

Create a series: the issue that is the definition

The issue’s own fields are the template an occurrence is created from, so --title, --labels and the rest are also what each occurrence inherits. The rule is validated before the issue is written.

§

Edit

Change a series’ name and/or rule, keeping its stable id

Only the flags you name change; the rest of the rule is carried over, so tix recurring edit <id> --name X is a rename and nothing else.

Fields

§series: String

Stable series id, or its unique display name

§

Detect

Report what is due, read-only, for an explicit date

Fields

§date: Option<String>

Evaluate against this YYYY-MM-DD date instead of today

§timezone: Option<String>

Timezone policy to carry on the context, e.g. +02:00

§

Generate

Create the occurrence for one due date; requires --yes

Idempotent: the occurrence key is checked first, so a repeated call is a no-op and never a second issue.

Fields

§series: String

Stable series id, or its unique display name

§date: String

The occurrence date, YYYY-MM-DD

§

Pause

Suspend generation until an explicit resume

Fields

§series: String

Stable series id, or its unique display name

§

Resume

Resume a paused series; never inferred from a refresh

Fields

§series: String

Stable series id, or its unique display name

§

End

End a series: terminal for generation

Fields

§series: String

Stable series id, or its unique display name

§

Skip

Record one occurrence date as skipped, so it is never generated

Fields

§series: String

Stable series id, or its unique display name

§date: String

The occurrence date, YYYY-MM-DD

§

Defer

Move the candidate past a date without recording it as skipped

Fields

§series: String

Stable series id, or its unique display name

§date: String

The occurrence date, YYYY-MM-DD

§

Ignore

Stop offering one occurrence date: recorded, like skip

Fields

§series: String

Stable series id, or its unique display name

§date: String

The occurrence date, YYYY-MM-DD

Trait Implementations§

Source§

impl Clone for RecurringAction

Source§

fn clone(&self) -> Self

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 Debug for RecurringAction

Source§

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

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

impl FromArgMatches for RecurringAction

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 RecurringAction

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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.