Struct bincode::config::DefaultOptions
source · pub struct DefaultOptions(_);Expand description
The default options for bincode serialization/deserialization.
Defaults
By default bincode will use little-endian encoding for multi-byte integers, and will not limit the number of serialized/deserialized bytes.
Configuring DefaultOptions
DefaultOptions implements the Options trait, which means it exposes functions to change the behavior of bincode.
For example, if you wanted to limit the bincode deserializer to 1 kilobyte of user input:
use bincode::Options;
let my_options = bincode::DefaultOptions::new().with_limit(1024);DefaultOptions struct vs. functions
The default configuration used by this struct is not the same as that used by the bincode helper functions in the root of this crate. See the config module for more details
Implementations§
source§impl DefaultOptions
impl DefaultOptions
sourcepub fn new() -> DefaultOptions
pub fn new() -> DefaultOptions
Get a default configuration object.
Default Configuration:
| Byte limit | Endianness | Int Encoding | Trailing Behavior |
|---|---|---|---|
| Unlimited | Little | Varint | Reject |
Trait Implementations§
source§impl Clone for DefaultOptions
impl Clone for DefaultOptions
source§fn clone(&self) -> DefaultOptions
fn clone(&self) -> DefaultOptions
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Default for DefaultOptions
impl Default for DefaultOptions
impl Copy for DefaultOptions
Auto Trait Implementations§
impl RefUnwindSafe for DefaultOptions
impl Send for DefaultOptions
impl Sync for DefaultOptions
impl Unpin for DefaultOptions
impl UnwindSafe for DefaultOptions
Blanket Implementations§
source§impl<T> Options for Twhere
T: InternalOptions,
impl<T> Options for Twhere
T: InternalOptions,
source§fn with_no_limit(self) -> WithOtherLimit<Self, Infinite>
fn with_no_limit(self) -> WithOtherLimit<Self, Infinite>
Sets the byte limit to be unlimited.
This is the default. Read more
source§fn with_limit(self, limit: u64) -> WithOtherLimit<Self, Bounded>
fn with_limit(self, limit: u64) -> WithOtherLimit<Self, Bounded>
Sets the byte limit to
limit.source§fn with_little_endian(self) -> WithOtherEndian<Self, LittleEndian>
fn with_little_endian(self) -> WithOtherEndian<Self, LittleEndian>
Sets the endianness to little-endian
This is the default. Read more
source§fn with_big_endian(self) -> WithOtherEndian<Self, BigEndian>
fn with_big_endian(self) -> WithOtherEndian<Self, BigEndian>
Sets the endianness to big-endian
source§fn with_native_endian(self) -> WithOtherEndian<Self, NativeEndian>
fn with_native_endian(self) -> WithOtherEndian<Self, NativeEndian>
Sets the endianness to the the machine-native endianness
source§fn with_varint_encoding(self) -> WithOtherIntEncoding<Self, VarintEncoding>
fn with_varint_encoding(self) -> WithOtherIntEncoding<Self, VarintEncoding>
Sets the length encoding to varint
source§fn with_fixint_encoding(self) -> WithOtherIntEncoding<Self, FixintEncoding>
fn with_fixint_encoding(self) -> WithOtherIntEncoding<Self, FixintEncoding>
Sets the length encoding to be fixed
source§fn reject_trailing_bytes(self) -> WithOtherTrailing<Self, RejectTrailing>
fn reject_trailing_bytes(self) -> WithOtherTrailing<Self, RejectTrailing>
Sets the deserializer to reject trailing bytes
source§fn allow_trailing_bytes(self) -> WithOtherTrailing<Self, AllowTrailing>
fn allow_trailing_bytes(self) -> WithOtherTrailing<Self, AllowTrailing>
Sets the deserializer to allow trailing bytes
source§fn serialize<S: ?Sized + Serialize>(self, t: &S) -> Result<Vec<u8>>
fn serialize<S: ?Sized + Serialize>(self, t: &S) -> Result<Vec<u8>>
Serializes a serializable object into a
Vec of bytes using this configurationsource§fn serialized_size<T: ?Sized + Serialize>(self, t: &T) -> Result<u64>
fn serialized_size<T: ?Sized + Serialize>(self, t: &T) -> Result<u64>
Returns the size that an object would be if serialized using Bincode with this configuration
source§fn serialize_into<W: Write, T: ?Sized + Serialize>(
self,
w: W,
t: &T
) -> Result<()>
fn serialize_into<W: Write, T: ?Sized + Serialize>(
self,
w: W,
t: &T
) -> Result<()>
Serializes an object directly into a
Writer using this configuration Read moresource§fn deserialize<'a, T: Deserialize<'a>>(self, bytes: &'a [u8]) -> Result<T>
fn deserialize<'a, T: Deserialize<'a>>(self, bytes: &'a [u8]) -> Result<T>
Deserializes a slice of bytes into an instance of
T using this configurationsource§fn deserialize_seed<'a, T: DeserializeSeed<'a>>(
self,
seed: T,
bytes: &'a [u8]
) -> Result<T::Value>
fn deserialize_seed<'a, T: DeserializeSeed<'a>>(
self,
seed: T,
bytes: &'a [u8]
) -> Result<T::Value>
Deserializes a slice of bytes with state
seed using this configuration.source§fn deserialize_from<R: Read, T: DeserializeOwned>(self, reader: R) -> Result<T>
fn deserialize_from<R: Read, T: DeserializeOwned>(self, reader: R) -> Result<T>
Deserializes an object directly from a
Reader using this configuration Read moresource§fn deserialize_from_seed<'a, R: Read, T: DeserializeSeed<'a>>(
self,
seed: T,
reader: R
) -> Result<T::Value>
fn deserialize_from_seed<'a, R: Read, T: DeserializeSeed<'a>>(
self,
seed: T,
reader: R
) -> Result<T::Value>
source§fn deserialize_from_custom<'a, R: BincodeRead<'a>, T: DeserializeOwned>(
self,
reader: R
) -> Result<T>
fn deserialize_from_custom<'a, R: BincodeRead<'a>, T: DeserializeOwned>(
self,
reader: R
) -> Result<T>
Deserializes an object from a custom
BincodeReader using the default configuration.
It is highly recommended to use deserialize_from unless you need to implement
BincodeRead for performance reasons. Read moresource§fn deserialize_from_custom_seed<'a, R: BincodeRead<'a>, T: DeserializeSeed<'a>>(
self,
seed: T,
reader: R
) -> Result<T::Value>
fn deserialize_from_custom_seed<'a, R: BincodeRead<'a>, T: DeserializeSeed<'a>>(
self,
seed: T,
reader: R
) -> Result<T::Value>
Deserializes an object from a custom
BincodeReader with state seed using the default
configuration. It is highly recommended to use deserialize_from unless you need to
implement BincodeRead for performance reasons. Read more