Struct aws_smithy_cbor::decode::Decoder

pub struct Decoder<'b> { /* private fields */ }

Provides functions for decoding a CBOR object with a known schema.

Although CBOR is a self-describing format, this decoder is tailored for cases where the schema is known in advance. Therefore, the caller can determine which object key exists at the current position by calling str method, and call the relevant function based on the predetermined schema for that key. If an unexpected key is encountered, the caller can use the skip method to skip over the element.

Implementations

impl<'b> Decoder<'b>

pub fn new(bytes: &'b [u8]) -> Self

pub fn datatype(&self) -> Result<Type, DeserializeError>

pub fn skip(&mut self) -> Result<(), DeserializeError>

pub fn boolean(&mut self) -> Result<bool, DeserializeError>

pub fn byte(&mut self) -> Result<i8, DeserializeError>

pub fn short(&mut self) -> Result<i16, DeserializeError>

pub fn integer(&mut self) -> Result<i32, DeserializeError>

pub fn long(&mut self) -> Result<i64, DeserializeError>

pub fn float(&mut self) -> Result<f32, DeserializeError>

pub fn double(&mut self) -> Result<f64, DeserializeError>

pub fn null(&mut self) -> Result<(), DeserializeError>

pub fn list(&mut self) -> Result<Option<u64>, DeserializeError>

pub fn map(&mut self) -> Result<Option<u64>, DeserializeError>

pub fn position(&self) -> usize

Returns the current position of the buffer, which will be decoded when any of the methods is called.

pub fn str(&mut self) -> Result<Cow<'b, str>, DeserializeError>

Returns a Cow::Borrowed(&str) if the element at the current position in the buffer is a definite length string. Otherwise, it returns a Cow::Owned(String) if the element at the current position is an indefinite-length string. An error is returned if the element is neither a definite length nor an indefinite-length string.

pub fn string(&mut self) -> Result<String, DeserializeError>

Allocates and returns a String if the element at the current position in the buffer is either a definite-length or an indefinite-length string. Otherwise, an error is returned if the element is not a string type.

pub fn blob(&mut self) -> Result<Blob, DeserializeError>

Returns a blob if the element at the current position in the buffer is a byte string. Otherwise, a DeserializeError error is returned.

pub fn timestamp(&mut self) -> Result<DateTime, DeserializeError>

Returns a DateTime if the element at the current position in the buffer is a timestamp. Otherwise, a DeserializeError error is returned.

Trait Implementations

impl<'b> Clone for Decoder<'b>

fn clone(&self) -> Decoder<'b>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'b> Debug for Decoder<'b>

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

Formats the value using the given formatter.