Skip to main content

CodeReadArgs

Struct CodeReadArgs 

Source
pub struct CodeReadArgs<'external_args> { /* private fields */ }
Expand description

Data structure containing expected input for external method invocation, eventually calling code_read() on the other side by the host.

This can be used with Env, though there are helper methods on this provided by extension trait that allow not dealing with this struct directly in simpler cases.

Implementations§

Source§

impl<'external_args> CodeReadArgs<'external_args>

Source

pub fn new( contract_code: &'external_args Address, code: &'external_args mut impl OutputArg<VariableBytes<MAX_CODE_SIZE>>, ) -> Self

Create a new instance.

A call can leave contents behind in outputs that are not valid values of their types, even when it succeeds. Hence outputs are given as OutputArg, which makes sure contents are parsed before they are accessed, unless every bit pattern is a valid value. After a successful call, query updated sizes of outputs with *_size() getters and set them with OutputArg::set_output_size(). The return value (if there is one) is initialized after a successful call, but it is not necessarily a valid value of its type and must be parsed, for example with IoType::try_from_ptr().

Source

pub fn code_size(&self) -> u32

Size of code output, updated by the host after the method call

Trait Implementations§

Source§

impl<'external_args> Debug for CodeReadArgs<'external_args>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ExternalArgs for CodeReadArgs<'_>

Source§

const FINGERPRINT: MethodFingerprint

Fingerprint of the method being called
Source§

const METADATA: &'static [u8] = METADATA

Metadata that corresponds to a method being called

Auto Trait Implementations§

§

impl<'external_args> !Send for CodeReadArgs<'external_args>

§

impl<'external_args> !Sync for CodeReadArgs<'external_args>

§

impl<'external_args> Freeze for CodeReadArgs<'external_args>

§

impl<'external_args> RefUnwindSafe for CodeReadArgs<'external_args>

§

impl<'external_args> Unpin for CodeReadArgs<'external_args>

§

impl<'external_args> UnsafeUnpin for CodeReadArgs<'external_args>

§

impl<'external_args> UnwindSafe for CodeReadArgs<'external_args>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.