Skip to main content

Shared

Struct Shared 

Source
pub struct Shared<T>(/* private fields */);
Available on crate feature sync-mutex only.
Expand description

State shared between the parts of a controller, across threads.

Implementations§

Source§

impl<T> Shared<T>

Source

pub const fn new(value: T) -> Self

Wraps value.

Source

pub fn borrow(&self) -> Ref<'_, T>

Borrows the contents.

§Panics

Without sync-mutex, if a mutable borrow is live — core::cell::RefCell’s rule. With it, never: a poisoned lock is recovered from rather than propagated, because a controller that stopped answering every node because one task panicked would turn one fault into an outage.

Source

pub fn borrow_mut(&self) -> RefMut<'_, T>

Borrows the contents exclusively.

§Panics

The same rule as Shared::borrow.

Source

pub fn into_inner(self) -> T

Takes the contents out.

Trait Implementations§

Source§

impl<T: Debug> Debug for Shared<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Shared<T>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<T> !Freeze for Shared<T>

§

impl<T> Forget for Shared<T>

§

impl<T> Move for Shared<T>

§

impl<T> RefUnwindSafe for Shared<T>

§

impl<T> Send for Shared<T>
where RwLock<T>: Send,

§

impl<T> Sync for Shared<T>
where RwLock<T>: Sync,

§

impl<T> Unpin for Shared<T>
where RwLock<T>: Unpin,

§

impl<T> UnsafeUnpin for Shared<T>
where RwLock<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for Shared<T>
where RwLock<T>: UnwindSafe,

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

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

fn try_from(value: U) -> Result<T, !>

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.