Trait borsh::ser::BorshSerialize

pub trait BorshSerialize {
    // Required method
    fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>;
}

A data-structure that can be serialized into binary format by NBOR.

use borsh::BorshSerialize;

/// derive is only available if borsh is built with `features = ["derive"]`
#[derive(BorshSerialize)]
struct MyBorshSerializableStruct {
    value: String,
}


let x = MyBorshSerializableStruct { value: "hello".to_owned() };
let mut buffer: Vec<u8> = Vec::new();
x.serialize(&mut buffer).unwrap();
let single_serialized_buffer_len = buffer.len();

x.serialize(&mut buffer).unwrap();
assert_eq!(buffer.len(), single_serialized_buffer_len * 2);

let mut buffer: Vec<u8> = vec![0; 1024 + single_serialized_buffer_len];
let mut buffer_slice_enough_for_the_data = &mut buffer[1024..1024 + single_serialized_buffer_len];
x.serialize(&mut buffer_slice_enough_for_the_data).unwrap();

Required Methods

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl BorshSerialize for SocketAddr

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for bool

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for f32

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for f64

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for i8

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for i16

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for i32

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for i64

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for i128

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for isize

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for str

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for u8

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for u16

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for u32

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for u64

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for u128

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for ()

fn serialize<W: Write>(&self, _writer: &mut W) -> Result<()>

impl BorshSerialize for usize

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for String

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for Ipv4Addr

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for Ipv6Addr

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for SocketAddrV4

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for SocketAddrV6

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroI8

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroI16

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroI32

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroI64

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroI128

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroU8

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroU16

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroU32

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroU64

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroU128

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for NonZeroUsize

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl BorshSerialize for RangeFull

fn serialize<W: Write>(&self, _writer: &mut W) -> Result<()>

impl<K, V> BorshSerialize for BTreeMap<K, V>

where K: BorshSerialize, V: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<K, V, H> BorshSerialize for HashMap<K, V, H>

where K: BorshSerialize + Ord, V: BorshSerialize, H: BuildHasher,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0> BorshSerialize for (T0,)

where T0: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1> BorshSerialize for (T0, T1)

where T0: BorshSerialize, T1: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2> BorshSerialize for (T0, T1, T2)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3> BorshSerialize for (T0, T1, T2, T3)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4> BorshSerialize for (T0, T1, T2, T3, T4)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5> BorshSerialize for (T0, T1, T2, T3, T4, T5)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize, T15: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize, T15: BorshSerialize, T16: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize, T15: BorshSerialize, T16: BorshSerialize, T17: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize, T15: BorshSerialize, T16: BorshSerialize, T17: BorshSerialize, T18: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> BorshSerialize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)

where T0: BorshSerialize, T1: BorshSerialize, T2: BorshSerialize, T3: BorshSerialize, T4: BorshSerialize, T5: BorshSerialize, T6: BorshSerialize, T7: BorshSerialize, T8: BorshSerialize, T9: BorshSerialize, T10: BorshSerialize, T11: BorshSerialize, T12: BorshSerialize, T13: BorshSerialize, T14: BorshSerialize, T15: BorshSerialize, T16: BorshSerialize, T17: BorshSerialize, T18: BorshSerialize, T19: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for Cow<'_, T>

where T: BorshSerialize + ToOwned + ?Sized,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for Option<T>

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for [T]

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for BTreeSet<T>

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for LinkedList<T>

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for VecDeque<T>

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T> BorshSerialize for Vec<T>

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T, E> BorshSerialize for Result<T, E>

where T: BorshSerialize, E: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T, H> BorshSerialize for HashSet<T, H>

where T: BorshSerialize + Ord, H: BuildHasher,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T, const N: usize> BorshSerialize for [T; N]

where T: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize + ?Sized> BorshSerialize for &T

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize + ?Sized> BorshSerialize for Box<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize + ?Sized> BorshSerialize for Rc<T>

This impl requires the ["rc"] Cargo feature of borsh.

Serializing a data structure containing Rc will serialize a copy of the contents of the Rc each time the Rc is referenced within the data structure. Serialization will not attempt to deduplicate these repeated data.

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize + ?Sized> BorshSerialize for Arc<T>

This impl requires the ["rc"] Cargo feature of borsh.

Serializing a data structure containing Arc will serialize a copy of the contents of the Arc each time the Arc is referenced within the data structure. Serialization will not attempt to deduplicate these repeated data.

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize> BorshSerialize for Range<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize> BorshSerialize for RangeFrom<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize> BorshSerialize for RangeInclusive<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize> BorshSerialize for RangeTo<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: BorshSerialize> BorshSerialize for RangeToInclusive<T>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl<T: ?Sized> BorshSerialize for PhantomData<T>

fn serialize<W: Write>(&self, _: &mut W) -> Result<()>

Implementors

impl BorshSerialize for Definition

impl BorshSerialize for Fields

impl BorshSerialize for BorshSchemaContainer

where Declaration: BorshSerialize, BTreeMap<Declaration, Definition>: BorshSerialize,