Struct ToolProgressStateRef 

pub struct ToolProgressStateRef<'a> { /* private fields */ }

Typed state reference for reading and writing state.

All modifications are automatically collected by the associated PatchSink.

Implementations

impl<'a> ToolProgressStateRef<'a>

pub fn progress(&self) -> TireaResult<f64>

Read the field value.

pub fn total(&self) -> TireaResult<Option<f64>>

Read the optional field value.

pub fn message(&self) -> TireaResult<Option<String>>

Read the optional field value.

pub fn set_progress(&self, value: f64) -> TireaResult<()>

Set the field value.

pub fn set_total(&self, value: Option<f64>) -> TireaResult<()>

Set the optional field value.

pub fn total_none(&self) -> TireaResult<()>

Set the optional field to null (None).

pub fn set_message(&self, value: Option<String>) -> TireaResult<()>

Set the optional field value.

pub fn message_none(&self) -> TireaResult<()>

Set the optional field to null (None).

pub fn delete_progress(&self) -> TireaResult<()>

Delete this field entirely from the object.

pub fn delete_total(&self) -> TireaResult<()>

Delete this field entirely from the object.

pub fn delete_message(&self) -> TireaResult<()>

Delete this field entirely from the object.

pub fn increment_progress(&self, amount: f64) -> TireaResult<()>

Increment the numeric field by the given amount.

pub fn decrement_progress(&self, amount: f64) -> TireaResult<()>

Decrement the numeric field by the given amount.