Struct StartedMessageArguments

pub struct StartedMessageArguments(/* private fields */);

Methods from Deref<Target = NodeComponentSourceMessageArguments>

pub fn get_source_name(&self) -> Result<KanziString, Error>

See: node_component_source_message_arguments::SOURCE_NAME_PROPERTY

pub fn set_source_name(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

See: node_component_source_message_arguments::SOURCE_NAME_PROPERTY

Methods from Deref<Target = MessageArguments>

pub fn as_ptr(&self) -> *mut MessageArgumentsWrapper

pub fn get_source(&self) -> Result<Option<Weak<Node>>, Error>

Returns the source node for a message.

pub fn set_handled(&self, handled: bool) -> Result<(), Error>

Sets the handling status for a message.

pub fn is_handled(&self) -> Result<bool, Error>

Returns whether the message is handled.

pub fn get_argument<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the value of an argument.

Returns

The value of the argument. If the argument is not present in this message arguments instance, returns the default value of the PropertyType.

pub fn get_optional_argument<T>( &self, property: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

Returns the value of an argument.

Returns

The value of the argument. If the argument is not present in this message arguments instance, returns None.

pub fn set_argument<T>( &self, property: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the value of an argument.

Trait Implementations

impl Deref for StartedMessageArguments

type Target = NodeComponentSourceMessageArguments

The resulting type after dereferencing.

fn deref(&self) -> &<StartedMessageArguments as Deref>::Target

Dereferences the value.

impl Inherits<MessageArguments> for StartedMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MessageArgumentsConstraint for StartedMessageArguments

fn create(domain: &Domain) -> Result<StartedMessageArguments, Error>