Struct MovementGuard

pub struct MovementGuard { /* private fields */ }

A RAII helper class to ensure that pending movements get marked as finished in case an error occurs. You can construct a guard for an existing Movement with MovementGuard::new. Alternatively, a MovementGuard can be coupled to a movement using MovementGuard::new_movement.

When the MovementGuard is dropped from the stack, it will finalize the movement according to the configured OnDropStatus unless MovementGuard::finish has already been called.

Implementations

impl<'a> MovementGuard

pub fn new(id: MovementId, manager: Arc<MovementManager>) -> Self

Constructs a MovementGuard to manage a pre-existing Movement.

Parameters:

• id: The ID of the Movement to update.
• manager: A reference to the MovementManager so the guard can update the Movement.

pub async fn new_movement( manager: Arc<MovementManager>, subsystem_id: SubsystemId, movement_kind: String, ) -> Result<Self, MovementError>

Constructs a MovementGuard and creates a new Movement for the guard to manage.

See MovementManager::new_movement for more information.

Parameters:

• manager: A reference to the MovementManager so the guard can update the Movement.
• subsystem_id: The ID of the subsystem that wishes to start a new movement.
• movement_kind: A descriptor for the type of movement being performed, e.g. “send”, “receive”, “round”.

pub async fn new_movement_at( manager: Arc<MovementManager>, subsystem_id: SubsystemId, movement_kind: String, at: DateTime<Local>, ) -> Result<Self, MovementError>

Similar to MovementGuard::new_movement with the ability to set a custom timestamp.

Parameters:

• manager: A reference to the MovementManager so the guard can update the Movement.
• subsystem_id: The ID of the subsystem that wishes to start a new movement.
• movement_kind: A descriptor for the type of movement being performed, e.g. “send”, “receive”, “round”.
• at: The timestamp to set the [MovementTimestamp::created_at] field to.

pub fn id(&self) -> MovementId

Gets the MovementId stored by this guard.

pub fn set_on_drop_status(&mut self, status: OnDropStatus)

Sets a different OnDropStatus to apply to the movement upon dropping the MovementGuard.

Parameters:

• on_drop: Determines what status the movement will be set to when the guard is dropped.

pub async fn apply_update( &self, update: MovementUpdate, ) -> Result<(), MovementError>

Applies an update to the managed Movement.

See MovementManager::update_movement for more information.

Parameters:

• update: Specifies properties to set on the movement. Option fields will be ignored if they are None. Some will result in that particular field being overwritten.

pub async fn apply_update_at( &self, update: MovementUpdate, at: DateTime<Local>, ) -> Result<(), MovementError>

Similar to MovementGuard::apply_update with the ability to set a custom timestamp.

Parameters:

• update: Specifies properties to set on the movement. Option fields will be ignored if they are None. Some will result in that particular field being overwritten.
• at: The timestamp to set the [MovementTimestamp::completed_at] field to.

pub async fn finish( &mut self, status: MovementStatus, ) -> Result<(), MovementError>

Finalizes a movement, setting it to the given MovementStatus. If the MovementGuard is dropped after calling this function, no further changes will be made to the Movement.

See MovementManager::finish_movement for more information.

Parameters:

• status: The final MovementStatus to set. Must not be MovementStatus::Pending.

pub async fn finish_at( &mut self, status: MovementStatus, at: DateTime<Local>, ) -> Result<(), MovementError>

Finalizes a movement, setting it to the given MovementStatus. If the MovementGuard is dropped after calling this function, no further changes will be made to the Movement.

See MovementManager::finish_movement for more information.

Parameters:

• status: The final MovementStatus to set. Must not be MovementStatus::Pending.
• at: The timestamp to set the [MovementTimestamp::completed_at] field to.

pub fn stop(&mut self)

Prevents the guard from making further changes to the movement after being dropped. Manual actions such as MovementGuard::apply_update will continue to work.

Trait Implementations

impl Drop for MovementGuard

fn drop(&mut self)

Executes the destructor for this type.