Struct FaultString 

pub struct FaultString { /* private fields */ }

A fault’s diagnostic message.

Carries a human-readable description of a fault on the host and nothing at all on a guest. Encodes to zero bytes regardless — see the module docs. Two FaultStrings are always equal: the message is diagnostic, so it is not part of the value’s identity, and comparisons behave the same on host and guest.

Implementations

impl FaultString

pub fn as_str(&self) -> &str

The message, or "<fault>" when none was recorded.

Host-only: a guest records no message, so there is nothing for this to return and it does not exist there. Reading a fault’s text is a diagnostic act, and diagnostics are a host concern.

pub fn empty() -> Self

A fault with no message.

pub fn via_display<V>(v: &V) -> Self

where V: Display + ?Sized,

Record v’s Display form as the message. A message longer than CAP is replaced with <too-big>.

pub fn from_display(s: impl Display) -> Self

via_display for a value passed by value.

Trait Implementations

impl Clone for FaultString

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstMaxSize for FaultString

const MAX_SIZE: Option<usize>

Worst-case CXS encoded size in bytes, or None if unbounded.

impl ConstMaxSize for FaultString

const MAX_SIZE: Option<usize>

Worst-case TXS encoded size in bytes, or None if unbounded.

impl ContractTypeName for FaultString

const NAME: ContractSpecIdView<'static>

The fully qualified id this type is known by in the contract spec.

impl ContractTypeRefSpec for FaultString

const INFO: ContractTypeInfo<'static>

The type reference. Transitive type definitions are not carried here; they are retained via the linker-anchor mechanism (__THRUPUT_SPEC_ANCHOR_ROOT) and resolved by spec-tool.

const SIGNED_PREIMAGE: Option<&'static ContractTypeView<'static>> = _

How this type appears as a signed-token preimage (ContractTypeView::SignedToken’s payload): the type itself by default, or None for a type-erased payload (the SDK’s Opaque overrides this).

impl ContractTypeSpec for FaultString

const TYPE_DEF: ContractTypeDefView<'static>

The type’s definition (struct, enum, or union) as a const view.

impl Debug for FaultString

Available on non-RISC-V RV32 only.

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

Formats the value using the given formatter.

impl Default for FaultString

fn default() -> Self

Returns the “default value” for a type.

impl Display for FaultString

Available on non-RISC-V RV32 only.

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

Formats the value using the given formatter.

impl Eq for FaultString

impl Error for FaultString

Available on non-RISC-V RV32 only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for FaultString

fn eq(&self, _other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'r> ReadXDR<'r> for FaultString

fn read_xdr<R: Reader<'r>>(_r: &mut R) -> ReadResult<Self>

Reads an XDR value from the reader.

fn read_xdr_in_place<'s, R>( r: &mut R, slot: Slot<'s, Self>, ) -> Result<Init<'s, Self>, ReadError>

where R: Reader<'r>,

Reads an XDR value directly into slot, without first building it on the stack.

impl WriteXDR for FaultString

fn write_xdr<F, W: Writer<F>>(&self, _w: &mut W) -> WriteResult<()>

Writes this value as XDR data to the writer.

unsafe fn write_xdr_unchecked<F, W: WriterUnchecked<F>>(&self, _w: &mut W)

Writes this value as XDR data to the writer, without runtime checks.