Enum SharedContainer 

pub enum SharedContainer {
    Value(Rc<RefCell<SharedValueContainer>>),
    Type(Rc<RefCell<SharedTypeContainer>>),
}

Variants

Value(Rc<RefCell<SharedValueContainer>>)

Type(Rc<RefCell<SharedTypeContainer>>)

Implementations

impl SharedContainer

pub fn try_set_property<'a>( &self, source_id: TransceiverId, maybe_dif_update_data: Option<&DIFUpdateData>, key: impl Into<ValueKey<'a>>, val: ValueContainer, ) -> Result<(), AccessError>

Sets a property on the value if applicable (e.g. for maps)

pub fn try_replace( &self, source_id: TransceiverId, maybe_dif_update_data: Option<&DIFUpdateData>, value: impl Into<ValueContainer>, ) -> Result<(), AccessError>

Sets a value on the reference if it is mutable and the type is compatible.

pub fn try_append_value<'a>( &self, source_id: TransceiverId, maybe_dif_update_data: Option<&DIFUpdateData>, value: impl Into<ValueContainer>, ) -> Result<(), AccessError>

Pushes a value to the reference if it is a list.

pub fn try_delete_property<'a>( &self, source_id: TransceiverId, maybe_dif_update_data: Option<&DIFUpdateData>, key: impl Into<ValueKey<'a>>, ) -> Result<(), AccessError>

Tries to delete a property from the reference if it is a map. Notifies observers if successful.

pub fn try_clear(&self, source_id: TransceiverId) -> Result<(), AccessError>

pub fn try_list_splice<'a>( &self, source_id: TransceiverId, maybe_dif_update_data: Option<&DIFUpdateData>, range: Range<u32>, items: Vec<ValueContainer>, ) -> Result<(), AccessError>

impl SharedContainer

pub fn observe(&self, observer: Observer) -> Result<u32, ObserverError>

Adds an observer to this reference that will be notified on value changes. Returns an error if the reference is immutable or a type reference. The returned u32 is an observer ID that can be used to remove the observer later.

pub fn unobserve(&self, observer_id: u32) -> Result<(), ObserverError>

Removes an observer by its ID. Returns an error if the observer ID is not found or the reference is immutable.

pub fn update_observer_options( &self, observer_id: u32, options: ObserveOptions, ) -> Result<(), ObserverError>

Updates the options for an existing observer by its ID. Returns an error if the observer ID is not found or the reference is immutable.

pub fn observers_ids(&self) -> Vec<u32>

Returns a list of all observer IDs currently registered to this reference. A type reference or immutable reference will always return an empty list.

pub fn unobserve_all(&self) -> Result<(), ObserverError>

Removes all observers from this reference. Returns an error if the reference is immutable.

pub fn notify_observers(&self, dif: &DIFUpdate<'_>)

Notifies all observers of a change represented by the given DIFUpdate.

pub fn has_observers(&self) -> bool

Check if there are any observers registered

impl SharedContainer

pub fn pointer_address(&self) -> PointerAddress

pub fn pointer(&self) -> Ref<'_, Pointer>

pub fn is_mutable(&self) -> bool

Checks if the reference is mutable. A reference is mutable if it is a mutable ValueReference and all references in the chain are mutable. TypeReferences are always immutable. FIXME #284: Do we really need this? Probably we already collapse the ref and then change it’s value and perform the mutability check on the most inner ref.

pub fn try_boxed( value_container: ValueContainer, allowed_type: Option<TypeDefinition>, pointer: Pointer, mutability: SharedContainerMutability, ) -> Result<Self, SharedValueCreationError>

Creates a new shared value containing the given value container

pub fn new_from_type( type_value: Type, pointer: Pointer, maybe_nominal_type_declaration: Option<NominalTypeDeclaration>, ) -> Self

pub fn boxed_mut( value_container: ValueContainer, pointer: Pointer, ) -> Result<Self, SharedValueCreationError>

pub fn boxed( value_container: impl Into<ValueContainer>, pointer: Pointer, ) -> Self

pub fn collapse_reference_chain(&self) -> SharedContainer

Collapses the reference chain to most inner reference to which this reference points.

pub fn collapse_to_value(&self) -> Rc<RefCell<Value>>

Converts a reference to its current value, collapsing any reference chains and converting type references to type values.

pub fn value_container(&self) -> ValueContainer

pub fn allowed_type(&self) -> TypeDefinition

pub fn actual_type(&self) -> TypeDefinition

pub fn is_type(&self) -> bool

pub fn mutable_reference(&self) -> Option<Rc<RefCell<SharedValueContainer>>>

Returns a mutable reference to the ValueReference if this is a mutable ValueReference.

pub fn set_value_container( &self, new_value_container: ValueContainer, ) -> Result<(), AssignmentError>

Sets the value container of the reference if it is mutable. If the reference is immutable, an error is returned.

impl SharedContainer

Getter for references

pub fn try_get_property<'a>( &self, key: impl Into<ValueKey<'a>>, ) -> Result<ValueContainer, AccessError>

Gets a property on the value if applicable (e.g. for map and structs)

Trait Implementations

impl Apply for SharedContainer

fn apply( &self, args: &[ValueContainer], ) -> Result<Option<ValueContainer>, ExecutionError>

Applies multiple ValueContainer arguments to self

fn apply_single( &self, arg: &ValueContainer, ) -> Result<Option<ValueContainer>, ExecutionError>

Applies a single ValueContainer argument to self

impl Clone for SharedContainer

fn clone(&self) -> SharedContainer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedContainer

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

Formats the value using the given formatter.

impl Display for SharedContainer

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

Formats the value using the given formatter.

impl From<SharedTypeContainer> for SharedContainer

fn from(reference: SharedTypeContainer) -> Self

Converts to this type from the input type.

impl From<SharedValueContainer> for SharedContainer

fn from(reference: SharedValueContainer) -> Self

Converts to this type from the input type.

impl Hash for SharedContainer

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 Identity for SharedContainer

Two references are identical if they point to the same data

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

Check if two values are strictly identical (same pointer, same value, same type, same permissions).

impl PartialEq for SharedContainer

PartialEq corresponds to pointer equality / identity for Reference.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralEq for SharedContainer

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

Check if two values are equal, ignoring the type.

impl ValueEq for SharedContainer

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

Check if two values are exactly equal, including the type.

impl Eq for SharedContainer