Struct soroban_sdk::xdr::DepthLimitedWrite

pub struct DepthLimitedWrite<W>where
    W: Write,{
    pub inner: W,
    /* private fields */
}

DepthLimitedWrite wraps a Write object and enforces a depth limit to recursive write operations. It maintains a depth_remaining state tracking remaining allowed recursion depth.

Fields

inner: W

Implementations

impl<W> DepthLimitedWrite<W>where W: Write,

pub fn new(inner: W, depth_limit: u32) -> DepthLimitedWrite<W>

Constructs a new DepthLimitedWrite.

• inner: The object implementing the Write trait.
• depth_limit: The maximum allowed recursion depth.

Trait Implementations

impl<W> DepthLimiter for DepthLimitedWrite<W>where W: Write,

fn enter(&mut self) -> Result<(), Error>

Decrements the depth_remaining. If the depth is already zero, an error is returned indicating that the maximum depth limit has been exceeded.

fn leave(&mut self) -> Result<(), Error>

Increments the depth. leave should be called in tandem with enter such that the depth doesn’t exceed the initial depth limit.

type DepthLimiterError = Error

A general error type for any type implementing, or an operation under the guard of DepthLimiter. It must at least include the error case where the depth limit is exceeded which is returned from enter.

fn with_limited_depth<T, F>( &mut self, f: F ) -> Result<T, Self::DepthLimiterError>where F: FnOnce(&mut Self) -> Result<T, Self::DepthLimiterError>,

Wraps a given function f with depth limiting guards. It triggers an enter before, and a leave after the execution of f.

impl<W> Write for DepthLimitedWrite<W>where W: Write,

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Forwards the write operation to the wrapped object.

fn flush(&mut self) -> Result<(), Error>

Forwards the flush operation to the wrapped object.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.