Trait soroban_sdk::xdr::next::ReadXdr
pub trait ReadXdr: Sized {
// Required method
fn read_xdr(r: &mut impl Read) -> Result<Self, Error>;
// Provided methods
fn read_xdr_base64(r: &mut impl Read) -> Result<Self, Error> { ... }
fn read_xdr_to_end(r: &mut impl Read) -> Result<Self, Error> { ... }
fn read_xdr_base64_to_end(r: &mut impl Read) -> Result<Self, Error> { ... }
fn read_xdr_into(&mut self, r: &mut impl Read) -> Result<(), Error> { ... }
fn read_xdr_into_to_end(&mut self, r: &mut impl Read) -> Result<(), Error> { ... }
fn read_xdr_iter<R>(r: &mut R) -> ReadXdrIter<&mut R, Self> ⓘ
where R: Read { ... }
fn read_xdr_base64_iter<R>(
r: &mut R
) -> ReadXdrIter<DecoderReader<'_, R>, Self> ⓘ
where R: Read { ... }
fn from_xdr(bytes: impl AsRef<[u8]>) -> Result<Self, Error> { ... }
fn from_xdr_base64(b64: impl AsRef<[u8]>) -> Result<Self, Error> { ... }
}Required Methods§
fn read_xdr(r: &mut impl Read) -> Result<Self, Error>
fn read_xdr(r: &mut impl Read) -> Result<Self, Error>
Read the XDR and construct the type.
Read bytes from the given read implementation, decoding the bytes as XDR, and construct the type implementing this interface from those bytes.
Just enough bytes are read from the read implementation to construct the type. Any residual bytes remain in the read implementation.
All implementations should continue if the read implementation returns
ErrorKind::Interrupted.
Use ReadXdr::read_xdr_to_end when the intent is for all bytes in the
read implementation to be consumed by the read.
Provided Methods§
fn read_xdr_base64(r: &mut impl Read) -> Result<Self, Error>
fn read_xdr_base64(r: &mut impl Read) -> Result<Self, Error>
Construct the type from the XDR bytes base64 encoded.
An error is returned if the bytes are not completely consumed by the deserialization.
fn read_xdr_to_end(r: &mut impl Read) -> Result<Self, Error>
fn read_xdr_to_end(r: &mut impl Read) -> Result<Self, Error>
Read the XDR and construct the type, and consider it an error if the read does not completely consume the read implementation.
Read bytes from the given read implementation, decoding the bytes as XDR, and construct the type implementing this interface from those bytes.
Just enough bytes are read from the read implementation to construct the type, and then confirm that no further bytes remain. To confirm no further bytes remain additional bytes are attempted to be read from the read implementation. If it is possible to read any residual bytes from the read implementation an error is returned. The read implementation may not be exhaustively read if there are residual bytes, and it is considered undefined how many residual bytes or how much of the residual buffer are consumed in this case.
All implementations should continue if the read implementation returns
ErrorKind::Interrupted.
fn read_xdr_base64_to_end(r: &mut impl Read) -> Result<Self, Error>
fn read_xdr_base64_to_end(r: &mut impl Read) -> Result<Self, Error>
Construct the type from the XDR bytes base64 encoded.
An error is returned if the bytes are not completely consumed by the deserialization.
fn read_xdr_into(&mut self, r: &mut impl Read) -> Result<(), Error>
fn read_xdr_into(&mut self, r: &mut impl Read) -> Result<(), Error>
Read the XDR and construct the type.
Read bytes from the given read implementation, decoding the bytes as XDR, and construct the type implementing this interface from those bytes.
Just enough bytes are read from the read implementation to construct the type. Any residual bytes remain in the read implementation.
All implementations should continue if the read implementation returns
ErrorKind::Interrupted.
Use ReadXdr::read_xdr_into_to_end when the intent is for all bytes
in the read implementation to be consumed by the read.
fn read_xdr_into_to_end(&mut self, r: &mut impl Read) -> Result<(), Error>
fn read_xdr_into_to_end(&mut self, r: &mut impl Read) -> Result<(), Error>
Read the XDR into the existing value, and consider it an error if the read does not completely consume the read implementation.
Read bytes from the given read implementation, decoding the bytes as XDR, and construct the type implementing this interface from those bytes.
Just enough bytes are read from the read implementation to construct the type, and then confirm that no further bytes remain. To confirm no further bytes remain additional bytes are attempted to be read from the read implementation. If it is possible to read any residual bytes from the read implementation an error is returned. The read implementation may not be exhaustively read if there are residual bytes, and it is considered undefined how many residual bytes or how much of the residual buffer are consumed in this case.
All implementations should continue if the read implementation returns
ErrorKind::Interrupted.
fn read_xdr_iter<R>(r: &mut R) -> ReadXdrIter<&mut R, Self> ⓘwhere
R: Read,
fn read_xdr_iter<R>(r: &mut R) -> ReadXdrIter<&mut R, Self> ⓘwhere R: Read,
Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.
Read bytes from the given read implementation, decoding the bytes as XDR, and construct the type implementing this interface from those bytes.
Just enough bytes are read from the read implementation to construct the type, and then confirm that no further bytes remain. To confirm no further bytes remain additional bytes are attempted to be read from the read implementation. If it is possible to read any residual bytes from the read implementation an error is returned. The read implementation may not be exhaustively read if there are residual bytes, and it is considered undefined how many residual bytes or how much of the residual buffer are consumed in this case.
All implementations should continue if the read implementation returns
ErrorKind::Interrupted.
fn read_xdr_base64_iter<R>(r: &mut R) -> ReadXdrIter<DecoderReader<'_, R>, Self> ⓘwhere
R: Read,
fn read_xdr_base64_iter<R>(r: &mut R) -> ReadXdrIter<DecoderReader<'_, R>, Self> ⓘwhere R: Read,
Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.
fn from_xdr(bytes: impl AsRef<[u8]>) -> Result<Self, Error>
fn from_xdr(bytes: impl AsRef<[u8]>) -> Result<Self, Error>
Construct the type from the XDR bytes.
An error is returned if the bytes are not completely consumed by the deserialization.
fn from_xdr_base64(b64: impl AsRef<[u8]>) -> Result<Self, Error>
fn from_xdr_base64(b64: impl AsRef<[u8]>) -> Result<Self, Error>
Construct the type from the XDR bytes base64 encoded.
An error is returned if the bytes are not completely consumed by the deserialization.