Skip to main content

DataStoreWrite

Struct DataStoreWrite 

Source
pub struct DataStoreWrite {
    pub busy: bool,
    pub done: bool,
    pub error: bool,
    pub error_message: String,
    /* private fields */
}
Expand description

Function block for writing a file to the DataStore.

Fields§

§busy: bool

True while waiting for a response from the datastore.

§done: bool

True when the write operation finishes successfully. Stays true until reset or restarted.

§error: bool

True if the operation failed.

§error_message: String

Error description (empty when no error).

Implementations§

Source§

impl DataStoreWrite

Source

pub fn new() -> Self

Create a new DataStoreWrite function block.

Source

pub fn is_busy(&self) -> bool

The FB is currently awaiting a response.

Source

pub fn is_error(&self) -> bool

The last write resulted in an error.

Source

pub fn start( &mut self, path: &str, data: Value, options: Value, client: &mut CommandClient, )

Start a new file write to the DataStore.

§Arguments
  • path - The path to the file relative to the datastore root (e.g., "config.json").
  • data - The JSON payload to save to the file.
  • options - Write options, such as {"create_dirs": true}.
  • client - The IPC command client.
Source

pub fn reset(&mut self)

Cancel the write and return to idle.

Source

pub fn tick(&mut self, timeout_ms: u32, client: &mut CommandClient)

Execute one scan cycle of the write state machine.

Trait Implementations§

Source§

impl Default for DataStoreWrite

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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