PayloadStreamInterface

Interface PayloadStreamInterface.

Extends the PSR-7 StreamInterface to provide additional functionality for payload handling. Implementations of this interface MUST support both standard stream operations and structured payload manipulation.

---

• Full name: \FastForward\Http\Message\PayloadStreamInterface
• Parent interfaces: \FastForward\Http\Message\PayloadAwareInterface, PayloadImmutableInterface, StreamInterface

Inherited methods

getPayload

Retrieves the payload contained within the object.

public getPayload(): mixed

This method MUST return the payload as originally provided or modified. The returned type MAY vary depending on the structure of the payload (e.g., array, object, scalar, or null).

Return Value:

the payload, which MAY be of any type including array, object, scalar, or null

---