ruma::serde

Struct Base64

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

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§

Source§

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

Source

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.

Source

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

Available on crate feature events only.

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

Source

pub fn encode(&self) -> String

Available on crate feature events only.

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

Source§

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

Source

pub fn into_inner(self) -> B

Available on crate feature events only.

Get the raw bytes held by this Base64 instance.

Source§

impl<C> Base64<C>
where C: Base64Config,

Source

pub fn empty() -> Base64<C>

Available on crate feature events only.

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

Source

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§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C, B> Debug for Base64<C, B>
where C: Base64Config, B: AsRef<[u8]>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, C> Deserialize<'de> for Base64<C>
where C: Base64Config,

Source§

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. Read more
Source§

impl<C, B> Display for Base64<C, B>
where C: Base64Config, B: AsRef<[u8]>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B> From<Base64<Standard, B>> for OwnedBase64PublicKey
where B: AsRef<[u8]>,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<C, B> Serialize for Base64<C, B>
where C: Base64Config, B: AsRef<[u8]>,

Source§

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. Read more
Source§

impl TryFrom<&Base64PublicKey> for Base64

Source§

type Error = Base64DecodeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<&OwnedBase64PublicKey> for Base64

Source§

type Error = Base64DecodeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<OwnedBase64PublicKey> for Base64

Source§

type Error = Base64DecodeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<C, B> Freeze for Base64<C, B>
where B: Freeze,

§

impl<C, B> RefUnwindSafe for Base64<C, B>
where B: RefUnwindSafe,

§

impl<C, B> Send for Base64<C, B>
where B: Send,

§

impl<C, B> Sync for Base64<C, B>
where B: Sync,

§

impl<C, B> Unpin for Base64<C, B>
where B: Unpin,

§

impl<C, B> UnwindSafe for Base64<C, B>
where B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T