Struct peace_item_tar_x::TarXItem

pub struct TarXItem<Id> { /* private fields */ }

Item for extracting a tar file.

The Id type parameter is needed for each tar extraction params to be a distinct type.

The following use cases are intended to be supported:

• A pristine directory with only the tar’s contents and nothing else (in progress).
• Extraction of a tar over an existing directory (not yet implemented).

Type Parameters

• Id: A zero-sized type used to distinguish different tar extraction parameters from each other.

Implementations

impl<Id> TarXItem<Id>

pub fn new(item_id: ItemId) -> Self

Returns a new TarXItem.

Trait Implementations

impl<Id> Clone for TarXItem<Id>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for TarXItem<Id>

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

Formats the value using the given formatter.

impl<Id> Item for TarXItem<Id>

where Id: Send + Sync + 'static,

type Data<'exec> = TarXData<'exec, Id>

Data that the item accesses at runtime.

type Error = TarXError

Consumer provided error type.

type Params<'exec> = TarXParams<Id>

Parameters to use this item.

type State = FileMetadatas

Summary of the managed item’s state.

type StateDiff = TarXStateDiff

Diff between the current and target States.

fn id(&self) -> &ItemId

Returns the ID of this full spec.

fn setup<'life0, 'life1, 'async_trait>( &'life0 self, _resources: &'life1 mut Resources<Empty> ) -> Pin<Box<dyn Future<Output = Result<(), TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Inserts an instance of each data type in [Resources].

fn try_state_current<'life0, 'life1, 'life2, 'life3, 'async_trait>( fn_ctx: FnCtx<'life0>, params_partial: &'life1 <Self::Params<'life2> as Params>::Partial, data: TarXData<'life3, Id> ) -> Pin<Box<dyn Future<Output = Result<Option<Self::State>, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Returns the current state of the managed item, if possible.

fn state_current<'life0, 'life1, 'life2, 'life3, 'async_trait>( fn_ctx: FnCtx<'life0>, params: &'life1 Self::Params<'life2>, data: TarXData<'life3, Id> ) -> Pin<Box<dyn Future<Output = Result<Self::State, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Returns the current state of the managed item.

fn try_state_goal<'life0, 'life1, 'life2, 'life3, 'async_trait>( fn_ctx: FnCtx<'life0>, params_partial: &'life1 <Self::Params<'life2> as Params>::Partial, data: TarXData<'life3, Id> ) -> Pin<Box<dyn Future<Output = Result<Option<Self::State>, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Returns the goal state of the managed item, if possible.

fn state_goal<'life0, 'life1, 'life2, 'life3, 'async_trait>( fn_ctx: FnCtx<'life0>, params: &'life1 Self::Params<'life2>, data: TarXData<'life3, Id> ) -> Pin<Box<dyn Future<Output = Result<Self::State, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Returns the goal state of the managed item.

fn state_diff<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( _params_partial: &'life0 <Self::Params<'life1> as Params>::Partial, _data: Self::Data<'life2>, state_current: &'life3 Self::State, state_goal: &'life4 Self::State ) -> Pin<Box<dyn Future<Output = Result<Self::StateDiff, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Returns the difference between two states.

fn state_clean<'life0, 'life1, 'life2, 'async_trait>( _params_partial: &'life0 <Self::Params<'life1> as Params>::Partial, _data: Self::Data<'life2> ) -> Pin<Box<dyn Future<Output = Result<Self::State, TarXError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Returns the representation of a clean State.

fn apply_check<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( params: &'life0 Self::Params<'life1>, data: Self::Data<'life2>, state_current: &'life3 Self::State, state_target: &'life4 Self::State, diff: &'life5 Self::StateDiff ) -> Pin<Box<dyn Future<Output = Result<ApplyCheck, Self::Error>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait,

Returns whether apply needs to be executed.

fn apply_dry<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'life6, 'async_trait>( fn_ctx: FnCtx<'life0>, params: &'life1 Self::Params<'life2>, data: Self::Data<'life3>, state_current: &'life4 Self::State, state_target: &'life5 Self::State, diff: &'life6 Self::StateDiff ) -> Pin<Box<dyn Future<Output = Result<Self::State, Self::Error>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, 'life6: 'async_trait,

Dry-run transform of the current state to the target state.

fn apply<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'life6, 'async_trait>( fn_ctx: FnCtx<'life0>, params: &'life1 Self::Params<'life2>, data: Self::Data<'life3>, state_current: &'life4 Self::State, state_target: &'life5 Self::State, diff: &'life6 Self::StateDiff ) -> Pin<Box<dyn Future<Output = Result<Self::State, Self::Error>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, 'life6: 'async_trait,

Transforms the current state to the target state.