Skip to main content

RcloneAction

Enum RcloneAction 

Source
pub enum RcloneAction {
    Copy {
        source_bucket: Option<String>,
        destination_bucket: Option<String>,
        local_output: Option<PathBuf>,
        report_bucket: Option<String>,
        transfers: Option<usize>,
        checkers: Option<usize>,
        tpslimit: Option<usize>,
        non_interactive: bool,
    },
    Delete {
        source_bucket: Option<String>,
        local_output: Option<PathBuf>,
        report_bucket: Option<String>,
        checkers: Option<usize>,
        non_interactive: bool,
    },
}

Variants§

§

Copy

Copies data from one configured bucket-config to another by shelling out to rclone copy, against a config file pigeon itself generates from the keyring (ADR-0136, reversing ADR-0101’s original raw-passthrough design). --transfers/--checkers/--tpslimit are overridable per-destination (ADR-0108); every other rclone performance/retry flag stays fixed.

Fields

§source_bucket: Option<String>

Where to pull from: a configured bucket-config alias, optionally composed with a prefix inside it – media is the whole bucket, media:mp4/ its mp4/ directory (ADR-0138). Unlike transform, an omitted prefix stays the bucket root (this job has no file-type concept to derive one from). Interactively selected when omitted and stdin is a terminal; required otherwise.

§destination_bucket: Option<String>

Where to push to, same alias[:prefix/] form as --source-bucket (ADR-0138). Interactively selected when omitted and stdin is a terminal; required otherwise.

§local_output: Option<PathBuf>

Local directory this run’s rclone log (also serving as this job’s report) and transcript are written under. Defaults to a directory under the OS temp directory when omitted. Unlike every other job, this is not a staging area for transferred data – rclone transfers directly source -> destination with no pigeon-side staging.

§report_bucket: Option<String>

Alias of a configured bucket-config this run’s report (the rclone log itself, for this job), the shared observability log, and a transcript of its printed output are uploaded to, always unencrypted, under a YYYY-MM-DD-job-name-{run-id}/ prefix (ADR-0100). Mandatory – interactively selected when omitted and stdin is a terminal; required otherwise.

§transfers: Option<usize>

rclone –transfers (concurrent file transfers). Defaults to 8 (ADR-0106) when omitted.

§checkers: Option<usize>

rclone –checkers (concurrent list/compare operations). Defaults to 16 (ADR-0106) when omitted.

§tpslimit: Option<usize>

rclone –tpslimit (transactions/sec ceiling across transfers and checkers combined). Unset by default – no rate cap – unless a specific destination needs one (ADR-0108).

§non_interactive: bool

Suppress every wizard prompt (ADR-0114): each omitted input resolves via its non-interactive fallback (or errors if none exists) instead of asking, and the final “proceed?” confirmation is auto-answered yes.

§

Delete

Recursively and permanently deletes everything in a configured bucket-config by shelling out to rclone purge (ADR-0110). Irreversible – there is no --dry-run and no undo beyond the existing --non-interactive/interactive confirmation. Unlike copy, there is no destination and no per-file transfer-rate tuning, since purge transfers no file content.

Fields

§source_bucket: Option<String>

What to recursively and permanently delete the contents of: a configured bucket-config alias, optionally composed with a prefix to scope the purge to one directory inside it (media:mp4/, ADR-0138). An omitted prefix purges the whole bucket. Interactively selected when omitted and stdin is a terminal; required otherwise.

§local_output: Option<PathBuf>

Local directory this run’s rclone log (also serving as this job’s report) and transcript are written under. Defaults to a directory under the OS temp directory when omitted.

§report_bucket: Option<String>

Alias of a configured bucket-config this run’s report, the shared observability log, and a transcript of its printed output are uploaded to, always unencrypted, under a YYYY-MM-DD-job-name-{run-id}/ prefix (ADR-0100). Mandatory – interactively selected when omitted and stdin is a terminal; required otherwise.

§checkers: Option<usize>

rclone –checkers (concurrent list operations during enumeration). Defaults to 16 when omitted.

§non_interactive: bool

Suppress every wizard prompt (ADR-0114): each omitted input resolves via its non-interactive fallback (or errors if none exists) instead of asking, and the final “proceed?” confirmation is auto-answered yes.

Trait Implementations§

Source§

impl Debug for RcloneAction

Source§

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

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

impl FromArgMatches for RcloneAction

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 RcloneAction

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

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

Source§

fn vzip(self) -> V

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