Struct Bcs

#[non_exhaustive]
pub struct Bcs {
    pub name: Option<String>,
    pub value: Option<Bytes>,
}

Bcs contains an arbitrary type that is serialized using the BCS format as well as a name that identifies the type of the serialized value.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

Name that identifies the type of the serialized value.

value: Option<Bytes>

Bytes of a BCS serialized value.

Implementations

impl Bcs

pub const NAME_FIELD: &'static MessageField

pub const VALUE_FIELD: &'static MessageField

impl Bcs

pub fn path_builder() -> BcsFieldPathBuilder

impl Bcs

pub const fn const_default() -> Self

pub fn name_opt_mut(&mut self) -> Option<&mut String>

If name is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn name_mut(&mut self) -> &mut String

Returns a mutable reference to name. If the field is unset, it is first initialized with the default value.

pub fn name_opt(&self) -> Option<&str>

If name is set, returns Some with the value; otherwise returns None.

pub fn set_name<T: Into<String>>(&mut self, field: T)

Sets name with the provided value.

pub fn with_name<T: Into<String>>(self, field: T) -> Self

Sets name with the provided value.

pub fn value_opt(&self) -> Option<&[u8]>

If value is set, returns Some with the value; otherwise returns None.

pub fn set_value<T: Into<Bytes>>(&mut self, field: T)

Sets value with the provided value.

pub fn with_value<T: Into<Bytes>>(self, field: T) -> Self

Sets value with the provided value.

impl Bcs

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn value(&self) -> &[u8]

Returns the value of value, or the default value if value is unset.

impl Bcs

pub fn serialize<T: Serialize>(value: &T) -> Result<Self, Error>

pub fn deserialize<'de, T: Deserialize<'de>>(&'de self) -> Result<T, Error>

Trait Implementations

impl Clone for Bcs

fn clone(&self) -> Bcs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bcs

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

Formats the value using the given formatter.

impl Default for Bcs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bcs

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Bcs> for Bytes

fn from(value: &Bcs) -> Self

Converts to this type from the input type.

impl From<&Bcs> for Vec<u8>

fn from(value: &Bcs) -> Self

Converts to this type from the input type.

impl From<Bcs> for Bytes

fn from(value: Bcs) -> Self

Converts to this type from the input type.

impl From<Bcs> for Vec<u8>

fn from(value: Bcs) -> Self

Converts to this type from the input type.

impl From<Bytes> for Bcs

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Bcs

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl Message for Bcs

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 MessageFields for Bcs

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Bcs

fn eq(&self, other: &Bcs) -> 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 Serialize for Bcs

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Bcs