Struct zkstate::ZkState

pub struct ZkState<T: Serialize + DeserializeOwned + Send + Sync> { /* fields omitted */ }

Implementations

impl<T: Serialize + DeserializeOwned + Send + Sync + 'static> ZkState<T>

pub fn new(
    zk: Arc<ZooKeeper>,
    zk_path: String,
    initial_state: T
) -> Result<Self>

pub fn empty(initial_state: T) -> Self

Create an Empty, do nothing, ZkState object.

pub fn expect(
    zk: Arc<ZooKeeper>,
    zk_path: String,
    timeout: Option<Duration>
) -> Result<Self>

Create a new instance of ZkState, but does not attempt to create an empty object if none already exists. Will wait for data to show up.

So, if you know that a ZkState instance will eventually appear at the /foo/bar znode, this will block waiting for that to show up.

TODO describe this better

pub fn update_handler<M: Fn(Change<Key, Value>) + Send + 'static>(
    &self,
    closure: M
) -> Result<(), ZkStructError>

Method to be invoked to handle state change notifications

pub fn get_update_channel(&self) -> Receiver<Change<Key, Value>>

Return a reference to the Crossbeam Receiver to get Change notifications

pub fn update<M: FnOnce(&mut T)>(&self, closure: M) -> Result<(), ZkStructError>

Update the shared object using a closure.

The closure is passed a reference to the contents of the ZkState. Once the closure returns, the shared state in Zookeeper is committed and the write locks released.

pub fn read(&self) -> Result<RwLockReadGuard<'_, T>, ZkStructError>

Returns a Result<RwLockReadGuard>

pub fn c_read(&self)

Consistent Read.

Preforms a check to make sure the local version is the same as the remote version before returning. If there is a mismatch, will preform a sync and return the latest object

pub fn d_read(&self) -> Result<RwLockReadGuard<'_, T>, ZkStructError>

Dirty Read.

Returns the local data, not failing if the data is too old

pub fn metadata(&self) -> (usize, i32)

pub fn get_id(&self) -> &String

Return the ID of this ZkState instance

Trait Implementations

impl<T: Clone + Serialize + DeserializeOwned + Send + Sync> Clone for ZkState<T>

fn clone(&self) -> ZkState<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Serialize + DeserializeOwned + Send + Sync + Debug + 'static> Debug for ZkState<T>

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

Formats the value using the given formatter.