Struct serde_with::base64::Base64

pub struct Base64<CHARSET: CharacterSet = Standard, PADDING: Format = Padded>(_);

Available on crate feature base64 only.

Serialize bytes with base64

The type serializes a sequence of bytes as a base64 string. It works on any type implementing AsRef<[u8]> for serialization and TryFrom<Vec<u8>> for deserialization.

The type allows customizing the character set and the padding behavior. The CHARSET is a type implementing CharacterSet. PADDING specifies if serializing should emit padding. Deserialization always supports padded and unpadded formats. formats::Padded emits padding and formats::Unpadded leaves it off.

use serde_with::base64::{Base64, Bcrypt, BinHex, Standard};
use serde_with::formats::{Padded, Unpadded};

#[serde_as]
#[derive(Serialize, Deserialize)]
struct B64 {
    // The default is the same as Standard character set with padding
    #[serde_as(as = "Base64")]
    default: Vec<u8>,
    // Only change the character set, implies padding
    #[serde_as(as = "Base64<BinHex>")]
    charset_binhex: Vec<u8>,

    #[serde_as(as = "Base64<Standard, Padded>")]
    explicit_padding: Vec<u8>,
    #[serde_as(as = "Base64<Bcrypt, Unpadded>")]
    no_padding: Vec<u8>,
}

let b64 = B64 {
    default: b"Hello World".to_vec(),
    charset_binhex: b"Hello World".to_vec(),
    explicit_padding: b"Hello World".to_vec(),
    no_padding: b"Hello World".to_vec(),
};
let json = serde_json::json!({
    "default": "SGVsbG8gV29ybGQ=",
    "charset_binhex": "5'8VD'mI8epaD'3=",
    "explicit_padding": "SGVsbG8gV29ybGQ=",
    "no_padding": "QETqZE6eT07wZEO",
});

// Test serialization and deserialization
assert_eq!(json, serde_json::to_value(&b64).unwrap());
assert_eq!(b64, serde_json::from_value(json).unwrap());

Trait Implementations

impl<CHARSET: Clone + CharacterSet, PADDING: Clone + Format> Clone for Base64<CHARSET, PADDING>

fn clone(&self) -> Base64<CHARSET, PADDING>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CHARSET: Debug + CharacterSet, PADDING: Debug + Format> Debug for Base64<CHARSET, PADDING>

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

Formats the value using the given formatter.

impl<CHARSET: Default + CharacterSet, PADDING: Default + Format> Default for Base64<CHARSET, PADDING>

fn default() -> Base64<CHARSET, PADDING>

Returns the “default value” for a type.

impl<'de, T, CHARSET, FORMAT> DeserializeAs<'de, T> for Base64<CHARSET, FORMAT> where
    T: TryFrom<Vec<u8>>,
    CHARSET: CharacterSet,
    FORMAT: Format, 

fn deserialize_as<D>(deserializer: D) -> Result<T, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T, CHARSET> SerializeAs<T> for Base64<CHARSET, Padded> where
    T: AsRef<[u8]>,
    CHARSET: CharacterSet, 

fn serialize_as<S>(source: &T, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, CHARSET> SerializeAs<T> for Base64<CHARSET, Unpadded> where
    T: AsRef<[u8]>,
    CHARSET: CharacterSet, 

fn serialize_as<S>(source: &T, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<CHARSET: Copy + CharacterSet, PADDING: Copy + Format> Copy for Base64<CHARSET, PADDING>