Struct cbor_data::ArrayWriter
source · pub struct ArrayWriter<'a> { /* private fields */ }
Expand description
Builder for an array value, used by write_array_ret()
.
see trait Encoder
for usage examples
Implementations§
source§impl<'a> ArrayWriter<'a>
impl<'a> ArrayWriter<'a>
sourcepub fn set_max_definite_size(&mut self, size: Option<u64>)
pub fn set_max_definite_size(&mut self, size: Option<u64>)
Configure the limit above which indefinite size encoding will be used.
The default is 255, which is the largest size up to which definite size is at least as
compact as indefinite size. Set to 23 to avoid moving bytes around when finishing the array.
Set to None
to always use indefinite size encoding.
Trait Implementations§
source§impl<'a> Writer for ArrayWriter<'a>
impl<'a> Writer for ArrayWriter<'a>
type Output = ArrayWriter<'a>
source§fn max_definite(&self) -> Option<u64>
fn max_definite(&self) -> Option<u64>
Configured maximum array or dict length up to which definite size encoding is used.
source§fn set_max_definite(&mut self, max: Option<u64>)
fn set_max_definite(&mut self, max: Option<u64>)
Set the maximum array or dict length up to which definite size encoding is used.
source§fn write_pos(
self,
value: u64,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_pos( self, value: u64, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write a unsigned value of up to 64 bits.
Tags are from outer to inner.
source§fn write_neg(
self,
value: u64,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_neg( self, value: u64, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write a negative value of up to 64 bits — the represented number is
-1 - value
.
Tags are from outer to inner.source§fn write_bytes(
self,
value: &[u8],
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_bytes( self, value: &[u8], tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write the given slice as a definite size byte string.
Tags are from outer to inner.
source§fn write_bytes_chunked(
self,
value: impl IntoIterator<Item = impl AsRef<[u8]>> + Copy,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_bytes_chunked( self, value: impl IntoIterator<Item = impl AsRef<[u8]>> + Copy, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write the given slices as a definite size byte string.
Tags are from outer to inner. Read more
source§fn write_str(
self,
value: &str,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_str( self, value: &str, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write the given slice as a definite size string.
Tags are from outer to inner.
source§fn write_str_chunked(
self,
value: impl IntoIterator<Item = impl AsRef<str>> + Copy,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_str_chunked( self, value: impl IntoIterator<Item = impl AsRef<str>> + Copy, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write the given slice as a definite size string.
Tags are from outer to inner. Read more
source§fn write_bool(
self,
value: bool,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_bool( self, value: bool, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Tags are from outer to inner.
source§fn write_null(self, tags: impl IntoIterator<Item = u64>) -> Self::Output
fn write_null(self, tags: impl IntoIterator<Item = u64>) -> Self::Output
Tags are from outer to inner.
source§fn write_undefined(self, tags: impl IntoIterator<Item = u64>) -> Self::Output
fn write_undefined(self, tags: impl IntoIterator<Item = u64>) -> Self::Output
Tags are from outer to inner.
source§fn write_lit(
self,
value: Literal,
tags: impl IntoIterator<Item = u64>
) -> Self::Output
fn write_lit( self, value: Literal, tags: impl IntoIterator<Item = u64> ) -> Self::Output
Write custom literal value — RFC 8949 §3.3 is required reading.
Tags are from outer to inner.
source§fn write_array<F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> Self::Outputwhere
F: FnOnce(&mut ArrayWriter<'_>),
fn write_array<F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> Self::Outputwhere
F: FnOnce(&mut ArrayWriter<'_>),
Write a nested array using the given closure that receives an array builder.
Tags are from outer to inner. Read more
source§fn write_array_ret<T, F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> (Self::Output, T)where
F: FnOnce(&mut ArrayWriter<'_>) -> T,
fn write_array_ret<T, F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> (Self::Output, T)where
F: FnOnce(&mut ArrayWriter<'_>) -> T,
Write a nested array using the given closure that receives an array builder.
Tags are from outer to inner. Read more
source§fn write_dict<F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> Self::Outputwhere
F: FnOnce(&mut DictWriter<'_>),
fn write_dict<F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> Self::Outputwhere
F: FnOnce(&mut DictWriter<'_>),
Write a nested dict using the given closure that receives a dict builder.
Tags are from outer to inner. Read more
source§fn write_dict_ret<T, F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> (Self::Output, T)where
F: FnOnce(&mut DictWriter<'_>) -> T,
fn write_dict_ret<T, F>(
self,
tags: impl IntoIterator<Item = u64>,
f: F
) -> (Self::Output, T)where
F: FnOnce(&mut DictWriter<'_>) -> T,
Write a nested dict using the given closure that receives a dict builder.
Tags are from outer to inner. Read more
source§fn write_canonical(self, bytes: &[u8]) -> Result<Self::Output, ParseError>
fn write_canonical(self, bytes: &[u8]) -> Result<Self::Output, ParseError>
Interpret the given bytes as a single CBOR item and write it to this builder,
canonicalising its contents like
CborOwned::canonical()
source§fn write_trusting(self, bytes: &[u8]) -> Self::Output
fn write_trusting(self, bytes: &[u8]) -> Self::Output
Assume that the given bytes are a well-formed single CBOR item and write it to this builder. Read more
source§fn write_item(self, item: &Cbor) -> Self::Output
fn write_item(self, item: &Cbor) -> Self::Output
Write the given CBOR item
Auto Trait Implementations§
impl<'a> Freeze for ArrayWriter<'a>
impl<'a> RefUnwindSafe for ArrayWriter<'a>
impl<'a> Send for ArrayWriter<'a>
impl<'a> Sync for ArrayWriter<'a>
impl<'a> Unpin for ArrayWriter<'a>
impl<'a> !UnwindSafe for ArrayWriter<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Encoder for Twhere
T: Writer,
impl<T> Encoder for Twhere
T: Writer,
fn encode_undefined(self) -> Self::Output
fn encode_null(self) -> Self::Output
fn encode_bool(self, value: bool) -> Self::Output
source§fn encode_u64(self, value: u64) -> Self::Output
fn encode_u64(self, value: u64) -> Self::Output
Encode an unsigned integer of at most 64 bit. Read more
source§fn encode_i64(self, value: i64) -> Self::Output
fn encode_i64(self, value: i64) -> Self::Output
Encode a signed integer of at most 64 bit. Read more
source§fn encode_f64(self, value: f64) -> Self::Output
fn encode_f64(self, value: f64) -> Self::Output
Encode a floating-point number of at most 64 bit. Read more
source§fn encode_timestamp(
self,
timestamp: Timestamp,
precision: Precision
) -> Self::Output
fn encode_timestamp( self, timestamp: Timestamp, precision: Precision ) -> Self::Output
Encode a timestamp with given target precision Read more
source§fn encode_number(self, number: &Number<'_>) -> Self::Output
fn encode_number(self, number: &Number<'_>) -> Self::Output
Encode a possibly big number Read more
source§fn encode_bytes(self, value: impl AsRef<[u8]>) -> Self::Output
fn encode_bytes(self, value: impl AsRef<[u8]>) -> Self::Output
Encode a byte string. Read more
source§fn encode_array<F>(self, f: F) -> Self::Outputwhere
F: FnOnce(&mut ArrayWriter<'_>),
fn encode_array<F>(self, f: F) -> Self::Outputwhere
F: FnOnce(&mut ArrayWriter<'_>),
Write an array that is then filled by the provided closure using the passed builder. Read more
source§fn encode_dict<F>(self, f: F) -> Self::Outputwhere
F: FnOnce(&mut DictWriter<'_>),
fn encode_dict<F>(self, f: F) -> Self::Outputwhere
F: FnOnce(&mut DictWriter<'_>),
Write a dict that is then filled by the provided closure using the passed builder. Read more