Struct socket_server_mocker::server_mocker_instruction::ServerMockerInstructionsList

pub struct ServerMockerInstructionsList { /* private fields */ }

Represents a list of network instructions to be executed by the server mocker

The list is executed in order, one instruction at a time.

The list is executed in a loop, until the StopExchange instruction is received.

Implementations

impl ServerMockerInstructionsList

Creates a new ServerMockerInstructionsList with the given instructions

Example

use socket_server_mocker::server_mocker_instruction::{ServerMockerInstruction, ServerMockerInstructionsList};
let mut instructions_list = ServerMockerInstructionsList::new_with_instructions([
    ServerMockerInstruction::ReceiveMessage,
    ServerMockerInstruction::SendMessage("hello from server".as_bytes().to_vec()),
].as_slice()).with_added_receive_message();
instructions_list.add_stop_exchange();

pub fn new() -> ServerMockerInstructionsList

Creates a new ServerMockerInstructionsList without instruction

pub fn new_with_instructions(
    instructions: &[ServerMockerInstruction]
) -> ServerMockerInstructionsList

Creates a new ServerMockerInstructionsList with the given instructions

Takes a slice of ServerMockerInstruction and clone it into the new ServerMockerInstructionsList

pub fn add_send_message(&mut self, message: BinaryMessage)

Add instruction for sending a message to the client

Takes self as a mutable reference

Message is given as a BinaryMessage

pub fn with_added_send_message(self, message: BinaryMessage) -> Self

Add instruction for sending a message to the client

Takes ownership of self and returns a new ServerMockerInstructionsList

Message is given as a BinaryMessage

pub fn add_send_message_depending_on_last_received_message(
    &mut self,
    message: fn(_: Option<BinaryMessage>) -> Option<BinaryMessage>
)

Add instruction for sending a message to the client depending on the last received message

Takes self as a mutable reference

If the given function returns None, no message is sent

pub fn with_added_send_message_depending_on_last_received_message(
    self,
    message: fn(_: Option<BinaryMessage>) -> Option<BinaryMessage>
) -> Self

Add instruction for sending a message to the client depending on the last received message

Takes ownership of self and returns a new ServerMockerInstructionsList

If the given function returns None, no message is sent

pub fn add_receive_message(&mut self)

Add instruction for waiting for a message to be received from the client

Takes self as a mutable reference

The message could be recovered with TcpServerMocker::pop_received_message()

pub fn with_added_receive_message(self) -> Self

Add instruction for waiting for a message to be received from the client

Takes ownership of self and returns a new ServerMockerInstructionsList

The message could be recovered with TcpServerMocker::pop_received_message()

pub fn add_receive_message_with_max_size(&mut self, max_size: usize)

Add instruction for waiting for a message to be received from the client with a maximum size

Takes self as a mutable reference

If the message is bigger than the given size, the message is truncated.

pub fn with_added_receive_message_with_max_size(self, max_size: usize) -> Self

Add instruction for waiting for a message to be received from the client with a maximum size

Takes ownership of self and returns a new ServerMockerInstructionsList

If the message is bigger than the given size, the message is truncated.

pub fn add_stop_exchange(&mut self)

Add instruction for stopping the exchange with the client, closing the connection.

Once the connection is closed, the client will receive an error when trying to send a message.

Takes self as a mutable reference

pub fn with_added_stop_exchange(self) -> Self

Add instruction for stopping the exchange with the client, closing the connection.

Once the connection is closed, the client will receive an error when trying to send a message.

Takes ownership of self and returns a new ServerMockerInstructionsList

Trait Implementations

impl Clone for ServerMockerInstructionsList

fn clone(&self) -> ServerMockerInstructionsList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerMockerInstructionsList

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

Formats the value using the given formatter.

impl PartialEq<ServerMockerInstructionsList> for ServerMockerInstructionsList

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

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

const 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 StructuralPartialEq for ServerMockerInstructionsList