Struct SocketScript 

pub struct SocketScript { /* private fields */ }

Available on crate features default-client and wire-mock and test-util only.

An ordered sequence of low-level socket actions for one connection.

Actions execute in insertion order. SocketScript::await_client_close, SocketScript::close, and SocketScript::reset are terminal and must be the final action. Reaching the end without a terminal action completes the script and closes the socket normally.

Implementations

impl SocketScript

pub fn new() -> Self

Creates an empty script.

pub fn read_http1_request(self) -> Self

Reads and records one complete fixed-length HTTP/1 request.

This uses the same bounded, Content-Length-only parser as Http1Script.

pub fn read_until(self, delimiter: impl AsRef<[u8]>, limit: usize) -> Self

Reads and discards through delimiter.

The action fails if the delimiter is not found within limit bytes.

pub fn read_exact(self, length: usize) -> Self

Reads and discards exactly length bytes, including any buffered bytes.

pub fn expect_bytes(self, expected: impl AsRef<[u8]>) -> Self

Reads exactly expected and fails if the bytes differ.

pub fn write_all(self, bytes: impl AsRef<[u8]>) -> Self

Writes all given bytes.

pub fn wait(self, gate: GateWaiter) -> Self

Records an arrival at gate and waits without a timeout for release.

pub fn delay(self, duration: Duration) -> Self

Delays the next action by duration.

Prefer ManualGate when elapsed time is not itself under test.

pub fn shutdown_write(self) -> Self

Shuts down the socket’s write half.

pub fn await_client_close(self) -> Self

Waits for the client to close and fails if it sends more bytes.

This is a terminal action.

Bytes already buffered by a preceding read also cause this action to fail.

pub fn close(self) -> Self

Closes the connection normally as the script’s terminal action.

pub fn reset(self) -> Self

Resets the connection using SO_LINGER=0 as the script’s terminal action.

Trait Implementations

impl Clone for SocketScript

fn clone(&self) -> SocketScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketScript

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

Formats the value using the given formatter.

impl Default for SocketScript

fn default() -> SocketScript

Returns the “default value” for a type.

impl From<SocketScript> for ConnectionScript

fn from(script: SocketScript) -> Self

Converts to this type from the input type.

impl From<SocketScript> for EndpointPlan

fn from(script: SocketScript) -> Self

Converts to this type from the input type.