StatePublisher

Struct StatePublisher 

Source
pub struct StatePublisher<const STATE_MAX: usize> { /* private fields */ }
Expand description

Publisher handle for a state layout.

§Contract

  • Intended for a single writer.
  • Each call to StatePublisher::publish overwrites the entire state value.
  • Publication uses the v1 parity protocol: readers should only accept snapshots observed at an even seq before and after the read.

Implementations§

Source§

impl<const STATE_MAX: usize> StatePublisher<STATE_MAX>

Source

pub fn new(inner: &StateLayoutCell<STATE_MAX>) -> Self

Create a publisher over a mapped layout without validating it.

Prefer try_new when constructing from an untrusted mapping.

Source

pub fn try_new(inner: &StateLayoutCell<STATE_MAX>) -> Result<Self, Error>

Create a publisher after validating the mapped layout.

Source

pub fn publish(&self, bytes: &[u8]) -> Result<u64, usize>

Overwrite the current state and return the new stable sequence number.

On success, the returned seq is even and can be used by readers as a monotonic marker.

§Errors

Returns Err(required_len) when bytes.len() > STATE_MAX. No bytes are published in this case.

Trait Implementations§

Source§

impl<const STATE_MAX: usize> Send for StatePublisher<STATE_MAX>

Auto Trait Implementations§

§

impl<const STATE_MAX: usize> Freeze for StatePublisher<STATE_MAX>

§

impl<const STATE_MAX: usize> !RefUnwindSafe for StatePublisher<STATE_MAX>

§

impl<const STATE_MAX: usize> !Sync for StatePublisher<STATE_MAX>

§

impl<const STATE_MAX: usize> Unpin for StatePublisher<STATE_MAX>

§

impl<const STATE_MAX: usize> !UnwindSafe for StatePublisher<STATE_MAX>

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, 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.