Struct ChangeValue

pub struct ChangeValue {
    pub value: u64,
    pub value_pool: i32,
    pub memo: Option<MemoBytes>,
    pub is_ephemeral: bool,
}

A proposed change or ephemeral output. If the transparent value pool is selected, the memo field must be null.

When the isEphemeral field of a ChangeValue is set, it represents an ephemeral output, which must be spent by a subsequent step. This is only supported for transparent outputs. Each ephemeral output will be given a unique t-address.

Fields

value: u64

The value of a change or ephemeral output to be created, in zatoshis.

value_pool: i32

The value pool in which the change or ephemeral output should be created.

memo: Option<MemoBytes>

The optional memo that should be associated with the newly created output. Memos must not be present for transparent outputs.

is_ephemeral: bool

Whether this is to be an ephemeral output.

Implementations

impl ChangeValue

pub fn value_pool(&self) -> ValuePool

Returns the enum value of value_pool, or the default if the field is set to an invalid enum value.

pub fn set_value_pool(&mut self, value: ValuePool)

Sets value_pool to the provided enum value.

impl ChangeValue

pub fn pool_type<T>(&self) -> Result<PoolType, ProposalDecodingError<T>>

Trait Implementations

impl Clone for ChangeValue

fn clone(&self) -> ChangeValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeValue

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

Formats the value using the given formatter.

impl Default for ChangeValue

fn default() -> Self

Returns the “default value” for a type.

impl Message for ChangeValue

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ChangeValue

fn eq(&self, other: &ChangeValue) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChangeValue