Struct MockNotifier

pub struct MockNotifier { /* private fields */ }

A client for sending Notification messages to a uEntity.

Please refer to the Communication Layer API Specifications.

Implementations

impl MockNotifier

pub fn checkpoint(&mut self)

Validate that all current expectations for all methods have been satisfied, and discard them.

pub fn new() -> Self

Create a new mock object with no expectations.

This method will not be generated if the real struct already has a new method. However, it will be generated if the struct implements a trait with a new method. The trait’s new method can still be called like <MockX as TraitY>::new

impl MockNotifier

pub fn expect_notify(&mut self) -> &mut Expectation

Create an Expectation for mocking the notify method

pub fn expect_start_listening(&mut self) -> &mut Expectation

Create an Expectation for mocking the start_listening method

pub fn expect_stop_listening(&mut self) -> &mut Expectation

Create an Expectation for mocking the stop_listening method

Trait Implementations

impl Debug for MockNotifier

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

Formats the value using the given formatter.

impl Default for MockNotifier

fn default() -> Self

Returns the “default value” for a type.

impl Notifier for MockNotifier

A client for sending Notification messages to a uEntity.

Please refer to the Communication Layer API Specifications.

fn notify<'life0, 'life1, 'async_trait>( &'life0 self, resource_id: u16, destination: &'life1 UUri, call_options: CallOptions, payload: Option<UPayload>, ) -> Pin<Box<dyn Future<Output = Result<(), NotificationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a notification to a uEntity.

Arguments

• resource_id - The (local) resource identifier representing the origin of the notification.
• destination - A URI representing the uEntity that the notification should be sent to.
• call_options - Options to include in the notification message.
• payload - The payload to include in the notification message.

Errors

Returns an error if the given message is not a valid uProtocol Notification message.

fn start_listening<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 UUri, listener: Arc<dyn UListener>, ) -> Pin<Box<dyn Future<Output = Result<(), RegistrationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Starts listening to a notification topic.

More than one handler can be registered for the same topic. The same handler can be registered for multiple topics.

Arguments

• topic - The topic to listen to. The topic must not contain any wildcards.
• listener - The handler to invoke for each notification that has been sent on the topic.

Errors

Returns an error if the listener cannot be registered.

fn stop_listening<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 UUri, listener: Arc<dyn UListener>, ) -> Pin<Box<dyn Future<Output = Result<(), RegistrationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deregisters a previously registered handler for listening to notifications.

Arguments

• topic - The topic that the handler had been registered for.
• listener - The handler to unregister.

Errors

Returns an error if the listener cannot be unregistered.