Struct ReferenceSyncEnv 

pub struct ReferenceSyncEnv { /* private fields */ }

Runs folder transfers by stating a transcript instead of moving anything.

Implementations

impl ReferenceSyncEnv

pub fn register_transcript(&mut self, lines: impl IntoIterator<Item = String>)

States exactly what the next transfer writes, whatever command it is given.

pub fn refuse_transfers(&mut self, reason: impl Into<String>)

Refuses every subsequent transfer, so failure laws can be exercised.

pub fn commands(&self) -> Vec<SyncCommand>

Observes every command the interpreter was asked to run, in order.

pub fn watched(&self) -> Vec<SyncObservation>

Observes everything the interpreter read out of its transfers, in order.

Trait Implementations

impl Clone for ReferenceSyncEnv

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceSyncEnv

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

Formats the value using the given formatter.

impl Default for ReferenceSyncEnv

fn default() -> Self

Returns the “default value” for a type.

impl RsyncEndpointAlg for ReferenceSyncEnv

where RsyncSyntax: RsyncEndpointAlg,

fn endpoint( &self, user: Option<String>, host: Option<String>, path: impl Into<String>, ) -> Self::Endpoint

Defines one endpoint from the account, the machine, and the path it names.

impl RsyncEndpointViewAlg for ReferenceSyncEnv

where RsyncSyntax: RsyncEndpointViewAlg,

fn endpoint_user<'a>(&self, endpoint: &'a Self::Endpoint) -> Option<&'a str>

Observes the account the far end is reached as, when one was stated.

fn endpoint_host<'a>(&self, endpoint: &'a Self::Endpoint) -> Option<&'a str>

Observes the machine the path rests on, and states nothing when the path is here.

fn endpoint_path<'a>(&self, endpoint: &'a Self::Endpoint) -> &'a str

Observes the path itself.

impl RsyncSorts for ReferenceSyncEnv

type Endpoint = RsyncEndpoint

Represents one end of a transfer.

type Command = SyncCommand

Represents exactly the command one transfer runs.

type Observation = SyncObservation

Represents one thing a running transfer states.

type Change = PlannedChange

Represents one path a transfer would change.

impl SyncChangeAlg for ReferenceSyncEnv

where RsyncSyntax: SyncChangeAlg,

fn sync_change( &self, path: impl Into<String>, kind: ChangeKind, size: Option<u64>, ) -> Self::Change

Defines one change from the path it names, what happens to it, and what it moves.

impl SyncCommandAlg for ReferenceSyncEnv

where RsyncSyntax: SyncCommandAlg,

fn sync_command( &self, program: impl Into<String>, arguments: impl IntoIterator<Item = String>, ) -> Self::Command

Defines the command running one program with exactly these arguments, in this order.

impl SyncCommandViewAlg for ReferenceSyncEnv

where RsyncSyntax: SyncCommandViewAlg,

fn command_program<'a>(&self, command: &'a Self::Command) -> &'a str

Observes the program the transfer is performed by.

fn command_arguments<'a>( &self, command: &'a Self::Command, ) -> impl Iterator<Item = &'a str>

Observes every argument, in the order the program is given them.

impl SyncObservationAlg for ReferenceSyncEnv

where RsyncSyntax: SyncObservationAlg,

fn observed_change(&self, change: Self::Change) -> Self::Observation

Defines the observation of one path the transfer would change, or has changed.

fn observed_progress(&self, transferred: u64, percent: u16) -> Self::Observation

Defines the observation of how far the whole transfer has come.

fn observed_nothing(&self) -> Self::Observation

Defines the observation of a line naming nothing this specification reads.

impl SyncObservationViewAlg for ReferenceSyncEnv

where RsyncSyntax: SyncObservationViewAlg,

fn observation_change<'a>( &self, observation: &'a Self::Observation, ) -> Option<&'a Self::Change>

Observes the changed path, exactly when the observation states one.

fn observation_progress( &self, observation: &Self::Observation, ) -> Option<(u64, u16)>

Observes the bytes moved and the share completed, exactly when the observation states them.

impl SyncRunAlg for ReferenceSyncEnv

type Error = ReferenceSyncError

Denotes failure to run the transfer.

type Run = VecDeque<String>

Carries one running transfer.

fn start_sync(&self, command: &Self::Command) -> Result<Self::Run, Self::Error>

Starts one transfer command.

fn next_sync_line( &self, run: &mut Self::Run, ) -> Result<Option<String>, Self::Error>

Reads the next line the running transfer wrote, and states when it has written its last.

fn finish_sync(&self, _run: Self::Run) -> Result<(), Self::Error>

Waits for the transfer to end and states whether it ended well.

impl SyncWatchAlg for ReferenceSyncEnv

fn watch_sync(&self, observation: &Self::Observation)

Applies one observation of the running transfer.