Struct ruma::serde::Base64

pub struct Base64<C = Standard, B = Vec<u8>> { /* private fields */ }

A wrapper around B (usually Vec<u8>) that (de)serializes from / to a base64 string.

The base64 character set (and miscellaneous other encoding / decoding options) can be customized through the generic parameter C.

Implementations

impl<C, B> Base64<C, B>

where C: Base64Config, B: AsRef<[u8]>,

pub fn new(bytes: B) -> Base64<C, B>

Available on crate feature events only.

Create a Base64 instance from raw bytes, to be base64-encoded in serialization.

pub fn as_bytes(&self) -> &[u8]

Available on crate feature events only.

Get a reference to the raw bytes held by this Base64 instance.

pub fn encode(&self) -> String

Available on crate feature events only.

Encode the bytes contained in this Base64 instance to unpadded base64.

impl<C, B> Base64<C, B>

pub fn into_inner(self) -> B

Available on crate feature events only.

Get the raw bytes held by this Base64 instance.

impl<C> Base64<C>

where C: Base64Config,

pub fn empty() -> Base64<C>

Available on crate feature events only.

Create a Base64 instance containing an empty Vec<u8>.

pub fn parse(encoded: impl AsRef<[u8]>) -> Result<Base64<C>, Base64DecodeError>

Available on crate feature events only.

Parse some base64-encoded data to create a Base64 instance.

Trait Implementations

impl<C, B> Clone for Base64<C, B>

where C: Clone, B: Clone,

fn clone(&self) -> Base64<C, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, B> Debug for Base64<C, B>

where C: Base64Config, B: AsRef<[u8]>,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for Base64<C>

where C: Base64Config,

fn deserialize<D>( deserializer: D, ) -> Result<Base64<C>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, B> Display for Base64<C, B>

where C: Base64Config, B: AsRef<[u8]>,

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

Formats the value using the given formatter.

impl<B> From<Base64<Standard, B>> for OwnedBase64PublicKey

where B: AsRef<[u8]>,

fn from(value: Base64<Standard, B>) -> OwnedBase64PublicKey

Converts to this type from the input type.

impl<C, B> Ord for Base64<C, B>

where C: Ord, B: Ord,

fn cmp(&self, other: &Base64<C, B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<C, B> PartialEq for Base64<C, B>

where C: PartialEq, B: PartialEq,

fn eq(&self, other: &Base64<C, B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C, B> PartialOrd for Base64<C, B>

where C: PartialOrd, B: PartialOrd,

fn partial_cmp(&self, other: &Base64<C, B>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C, B> Serialize for Base64<C, B>

where C: Base64Config, B: AsRef<[u8]>,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Base64PublicKey> for Base64

type Error = Base64DecodeError

The type returned in the event of a conversion error.

fn try_from( value: &Base64PublicKey, ) -> Result<Base64, <Base64 as TryFrom<&Base64PublicKey>>::Error>

Performs the conversion.

impl TryFrom<&OwnedBase64PublicKey> for Base64

type Error = Base64DecodeError

The type returned in the event of a conversion error.

fn try_from( value: &OwnedBase64PublicKey, ) -> Result<Base64, <Base64 as TryFrom<&OwnedBase64PublicKey>>::Error>

Performs the conversion.

impl TryFrom<OwnedBase64PublicKey> for Base64

type Error = Base64DecodeError

The type returned in the event of a conversion error.

fn try_from( value: OwnedBase64PublicKey, ) -> Result<Base64, <Base64 as TryFrom<OwnedBase64PublicKey>>::Error>

Performs the conversion.

impl<C, B> Eq for Base64<C, B>

where C: Eq, B: Eq,

impl<C, B> StructuralPartialEq for Base64<C, B>