Struct ori_core::ReadSignal

pub struct ReadSignal<T: ?Sized> { /* private fields */ }

A read-only Signal.

Implementations

impl<T> ReadSignal<T>

pub fn new(value: T) -> Self

Creates a new ReadSignal from a value.

impl<T: ?Sized> ReadSignal<T>

pub fn new_arc(value: Rc<T>) -> Self

Creates a new ReadSignal from an [Shared].

pub fn emitter(&self) -> &CallbackEmitter

Gets the CallbackEmitter for this ReadSignal.

pub fn track(&self)

Tracks self in the currently running effect.

pub fn get(&self) -> Rc<T>

Gets the current value of self.

This will track self in the currently running effect.

pub fn get_untracked(&self) -> Rc<T>

Gets the current value of self without tracking it.

impl<T: Clone> ReadSignal<T>

pub fn cloned(&self) -> T

Returns a clone of the current value of self.

This will track self in the currently running effect.

pub fn cloned_untracked(&self) -> T

Returns a clone of the current value of self without tracking it.

impl<T: Copy> ReadSignal<T>

pub fn copied(&self) -> T

Returns a copy to the current value of self.

pub fn copied_untracked(&self) -> T

Returns a copy to the current value of self.

Trait Implementations

impl<T: Debug + ?Sized> Debug for ReadSignal<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ReadSignal<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<&ReadSignal<T>> for StyleAttributeValuewhere T: Into<StyleAttributeValue> + Clone,

fn from(value: &ReadSignal<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + ?Sized> Hash for ReadSignal<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + ?Sized> Ord for ReadSignal<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized> PartialEq<ReadSignal<T>> for ReadSignal<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialEq + ?Sized> PartialEq<T> for ReadSignal<T>

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + ?Sized> PartialOrd<ReadSignal<T>> for ReadSignal<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialOrd + ?Sized> PartialOrd<T> for ReadSignal<T>

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + ?Sized> Eq for ReadSignal<T>