Struct cosmwasm_std::Binary

pub struct Binary(pub Vec<u8>);

Binary is a wrapper around Vec to add base64 de/serialization with serde. It also adds some helper methods to help encode inline.

This is only needed as serde-json-{core,wasm} has a horrible encoding for Vec

Implementations

impl Binary

pub fn from_base64(encoded: &str) -> StdResult<Self>

take an (untrusted) string and decode it into bytes. fails if it is not valid base64

pub fn to_base64(&self) -> String

encode to base64 string (guaranteed to be success as we control the data inside). this returns normalized form (with trailing = if needed)

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

pub fn to_array<const LENGTH: usize>(&self) -> StdResult<[u8; LENGTH]>

Copies content into fixed-sized array. The result type A: ByteArray is a workaround for the missing const-generics. A is a fixed-sized array like [u8; 8].

ByteArray is implemented for [u8; 0] to [u8; 64], such that we are limited to 64 bytes for now.

Examples

Copy to array of explicit length

let binary = Binary::from(&[0xfb, 0x1f, 0x37]);
let array: [u8; 3] = binary.to_array().unwrap();
assert_eq!(array, [0xfb, 0x1f, 0x37]);

Copy to integer

let binary = Binary::from(&[0x8b, 0x67, 0x64, 0x84, 0xb5, 0xfb, 0x1f, 0x37]);
let num = u64::from_be_bytes(binary.to_array().unwrap());
assert_eq!(num, 10045108015024774967);

Trait Implementations

impl Clone for Binary

fn clone(&self) -> Binary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Binary

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

Formats the value using the given formatter.

impl Default for Binary

fn default() -> Binary

Returns the “default value” for a type.

impl Deref for Binary

Just like Vec, Binary is a smart pointer to u8. This implements *binary for us and allows us to do &*binary, returning a &[u8] from a &Binary. With deref coercions, this allows us to use &binary whenever a &[u8] is required.

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Binary

Deserializes as a base64 string

fn deserialize<D>(deserializer: D) -> Result<Binary, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Binary

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

Formats the value using the given formatter.

impl<const LENGTH: usize> From<&'_ [u8; LENGTH]> for Binary

fn from(source: &[u8; LENGTH]) -> Self

Performs the conversion.

impl From<&'_ [u8]> for Binary

fn from(binary: &[u8]) -> Self

Performs the conversion.

impl<const LENGTH: usize> From<[u8; LENGTH]> for Binary

fn from(source: [u8; LENGTH]) -> Self

Performs the conversion.

impl From<Binary> for Vec<u8>

fn from(original: Binary) -> Vec<u8>

Performs the conversion.

impl From<Vec<u8, Global>> for Binary

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

Performs the conversion.

impl Hash for Binary

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Binary

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Binary

fn cmp(&self, other: &Binary) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<&'_ [u8]> for Binary

Implement Binary == &[u8]

fn eq(&self, rhs: &&[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Binary> for Binary

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Binary> for Vec<u8>

Implement std::vec::Vec<u8> == encoding::Binary

fn eq(&self, rhs: &Binary) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Binary> for &[u8]

Implement &[u8] == Binary

fn eq(&self, rhs: &Binary) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Vec<u8, Global>> for Binary

Implement encoding::Binary == std::vec::Vec<u8>

fn eq(&self, rhs: &Vec<u8>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Binary> for Binary

fn partial_cmp(&self, other: &Binary) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Binary

Serializes as a base64 string

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

Serialize this value into the given Serde serializer.

impl Eq for Binary

impl StructuralEq for Binary

impl StructuralPartialEq for Binary