Struct BytesFormat 

pub struct BytesFormat(/* private fields */);

How bytes are represented in formats without native bytes.

This is used in three places:

• The serializers of formats without native bytes (JSON and TOML) can be configured with a format. It’s used for all bytes that do not request a format. The default is BytesFormat::BASE64.
• Bytes can carry a format as fallback (see Bytes::fallback) which takes precedence over the configuration of the serializer. The BytesFallback adapter does this.
• The types that expect bytes decode strings with the format placed into the State (see set). The deserializers of formats without native bytes can be configured to do this, otherwise lenient base64 is used. Strings are decoded as base64 for BytesFormat::SEQ.

use deser::adapters::Base64UrlNoPad;
use deser::BytesFormat;

const URL_SAFE: BytesFormat = BytesFormat::encoded::<Base64UrlNoPad>();
assert_eq!(URL_SAFE.encode(b"\xfb\xff").as_deref(), Some("-_8"));
// decoding is lenient
assert_eq!(URL_SAFE.decode("+/8=").unwrap(), b"\xfb\xff");
assert_eq!(BytesFormat::SEQ.encode(b"\x01\xff"), None);

Two formats are equal if they are both sequences or encodings with the same name.

Implementations

impl BytesFormat

pub const BASE64: BytesFormat

Bytes are strings in base64 with the standard alphabet and padding.

This is the default.

pub const SEQ: BytesFormat

Bytes are sequences of integers.

This is how serde_json represents bytes.

pub const fn encoded<E: BytesEncoding>() -> BytesFormat

Bytes are strings in the given encoding.

pub fn of(state: &State) -> BytesFormat

Returns the format the types that expect bytes decode strings with.

This is BytesFormat::BASE64 unless the deserializer of the format set a different one.

pub fn set(self, state: &mut State)

Sets the format the types that expect bytes decode strings with.

pub fn name(&self) -> &'static str

Returns the name of the format.

This is the name of the encoding or seq.

pub fn is_seq(&self) -> bool

Returns true if bytes are sequences of integers.

pub fn encode(&self, bytes: &[u8]) -> Option<String>

Encodes bytes as string.

Returns None if bytes are sequences of integers.

pub fn decode(&self, s: &str) -> Result<Vec<u8>, Error>

Decodes bytes from a string.

For sequences of integers the string is decoded as base64.

Trait Implementations

impl Clone for BytesFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BytesFormat

impl Debug for BytesFormat

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

Formats the value using the given formatter.

impl Default for BytesFormat

fn default() -> BytesFormat

Returns the “default value” for a type.

impl Eq for BytesFormat

impl PartialEq for BytesFormat

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

Equality operator ==.

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

Inequality operator !=.