Crate sbor

Re-exports

• pub extern crate paste;
• pub use categorize::Categorize;
• pub use categorize::SborEnum;
• pub use categorize::SborTuple;
• pub use decode::Decode;
• pub use decoder::BorrowingDecoder;
• pub use decoder::DecodeError;
• pub use decoder::Decoder;
• pub use decoder::VecDecoder;
• pub use encode::Encode;
• pub use encoder::EncodeError;
• pub use encoder::Encoder;
• pub use encoder::VecEncoder;
• pub use path::SborPath;
• pub use path::SborPathBuf;
• pub use basic::*;
• pub use constants::*;
• pub use encoded_wrappers::*;
• pub use payload_validation::*;
• pub use schema::*;
• pub use value::*;
• pub use value_kind::*;
• pub use versioned::*;

Modules

• basic
  SBOR basic, no custom types
• categorize
  SBOR Categorize trait
• codec
  SBOR codec for core Rust types.
• constants
  SBOR constants
• decode
  SBOR decode trait.
• decoder
  SBOR decoding.
• encode
  SBOR encode trait.
• encoded_wrappers
  SBOR payload wrappers. These are new types around an encoded payload or sub-payload, with helper methods / traits implemented. They can be used as a more efficient wrapper a ScryptoValue if the content of that value is not needed.
• encoder
  SBOR encoding.
• enum_variant 🔒
• path
  SBOR paths.
• payload_validation
  SBOR payload validation.
• prelude
  Each module should have its own prelude, which:
• representations
  SBOR textual representations
• rust
  A facade of Rust types.
• schema
  SBOR Schema
• traversal
  SBOR structured payload traversal.
• value
  SBOR value model and any decoding/encoding.
• value_kind
  SBOR value kinds - ie the types of value that are supported.
• versioned
  Data model versioning helper macro

Macros

• create_well_known_lookup
• define_single_versioned
  This macro is intended for creating a data model which supports versioning. This is useful for creating an SBOR data model which can be updated in future. In future, enum variants can be added, and automatically mapped to.
• define_versioned
  This macro is intended for creating a data model which supports versioning. This is useful for creating an SBOR data model which can be updated in future. In future, enum variants can be added, and automatically mapped to.
• look_up_type
• numeric_validation_match
• return_if_error
• return_type_mismatch_error
• terminal_value
• terminal_value_from_body

Structs

• FixedEnumVariant

Traits

• IsFixedEnumVariant

Derive Macros

• BasicCategorize
  Derive code that returns the value kind - specifically for Basic SBOR.
• BasicDecode
  Derive code that decodes this data structure from a byte array - specifically for Basic SBOR.
• BasicDescribe
  Derive code that describes the type - specifically for Basic SBOR.
• BasicEncode
  Derive code that encodes this data structure - specifically for Basic SBOR.
• BasicSbor
  A shortcut for BasicCategorize, BasicEncode, BasicDecode, and BasicDescribe derives.
• Categorize
  Derive code that returns the value kind.
• Decode
  Derive code that decodes this data structure from a byte array.
• Describe
  Derive code that describes this type.
• Encode
  Derive code that encodes this data structure
• Sbor
  A shortcut for Categorize, Encode, Decode, and Describe derives.